Feature/byte range streams

Platform/Apple/RDServices/Main/RDContainer.mm

@@ -36,7 +36,7 @@
 
 @interface RDContainer () {
 	@private std::shared_ptr<ePub3::Container> m_container;
-    @private __weak id <RDContainerDelegate> m_delegate;
+	@private __weak id <RDContainerDelegate> m_delegate;
 	@private NSMutableArray *m_packages;
 	@private ePub3::Container::PackageList m_packageList;
 	@private NSString *m_path;
@@ -58,26 +58,26 @@ - (RDPackage *)firstPackage {
 
 
 - (instancetype)initWithDelegate:(id <RDContainerDelegate>)delegate path:(NSString *)path {
-    if (path == nil || ![[NSFileManager defaultManager] fileExistsAtPath:path]) {
+	if (path == nil || ![[NSFileManager defaultManager] fileExistsAtPath:path]) {
 		return nil;
 	}
 
 	if (self = [super init]) {
-        m_delegate = delegate;
+		m_delegate = delegate;
 
-        ePub3::ErrorHandlerFn sdkErrorHandler = ^(const ePub3::error_details& err) {
+		ePub3::ErrorHandlerFn sdkErrorHandler = ^(const ePub3::error_details& err) {
 
-            const char * msg = err.message();
-            [m_delegate container:self handleSdkError:[NSString stringWithUTF8String:msg]];
+			const char * msg = err.message();
+			[m_delegate container:self handleSdkError:[NSString stringWithUTF8String:msg]];
 
-            //TODO? pass to delegate more information from ePub3::error_details (see error_handler.h)
+			//TODO? pass to delegate more information from ePub3::error_details (see error_handler.h)
 
-            return ePub3::DefaultErrorHandler(err);
-        };
-        ePub3::SetErrorHandler(sdkErrorHandler);
+			return ePub3::DefaultErrorHandler(err);
+		};
+		ePub3::SetErrorHandler(sdkErrorHandler);
 
-        ePub3::InitializeSdk();
-        ePub3::PopulateFilterManager();
+		ePub3::InitializeSdk();
+		ePub3::PopulateFilterManager();
 
 		m_path = path;
 		m_container = ePub3::Container::OpenContainer(path.UTF8String);

Platform/Apple/RDServices/Main/RDPackage.h

@@ -69,4 +69,11 @@
 // Returns the resource at the given relative path or nil if it doesn't exist.
 - (RDPackageResource *)resourceAtRelativePath:(NSString *)relativePath;
 
+// Gets the current Byte Stream and returns the proper Byte Stream for the case.
+// There can be three possible byte streams:
+// - A simple ZipFileByteStream when no ContentFilter objects apply for this resource.
+// - A FilterChainByteStreamRange when a Byte Range request has been made, and only one ContentFilter object applies.
+// - A FilterChainByteStream when it is not a Byte Range request or more than one ContentFilter applies.
+- (void *)getProperByteStream:(NSString *)relativePath currentByteStream:(void *)currentByteStream isRangeRequest:(BOOL)isRangeRequest;
+
 @end

Platform/Apple/RDServices/Main/RDPackage.mm

@@ -38,8 +38,7 @@
 #import "RDSpineItem.h"
 
 
-@interface RDPackage() <RDPackageResourceDelegate> {
-	@private std::vector<std::unique_ptr<ePub3::ByteStream>> m_byteStreamVector;
+@interface RDPackage() {
 	@private RDMediaOverlaysSmilModel *m_mediaOverlaysSmilModel;
 	@private RDNavigationElement *m_navElemListOfFigures;
 	@private RDNavigationElement *m_navElemListOfIllustrations;
@@ -109,7 +108,7 @@ - (NSDictionary *)dictionary {
 	if (sss != nil) {
 		[dictRoot setObject:sss forKey:@"rendition_spread"];
 	}
-    
+
 	NSString *ssss = self.renditionOrientation;
 	if (ssss != nil) {
 		[dictRoot setObject:ssss forKey:@"rendition_orientation"];
@@ -260,18 +259,6 @@ - (NSString *)packageID {
 }
 
 
-- (void)packageResourceWillDeallocate:(RDPackageResource *)packageResource {
-	for (auto i = m_byteStreamVector.begin(); i != m_byteStreamVector.end(); i++) {
-		if (i->get() == packageResource.byteStream) {
-			m_byteStreamVector.erase(i);
-			return;
-		}
-	}
-
-	NSLog(@"The byte stream was not found!");
-}
-
-
 - (RDNavigationElement *)pageList {
 	if (m_navElemPageList == nil) {
 		ePub3::NavigationTable *navTable = m_package->PageList().get();
@@ -284,75 +271,75 @@ - (RDNavigationElement *)pageList {
 }
 
 - (NSString *)findProperty:(NSString *)propName withOptionalPrefix:(NSString *)prefix {
-    NSString *value = [self findProperty:propName withPrefix:prefix];
-
-    if (value.length == 0) {
-        value = [self findProperty:propName withPrefix:@""];
-    }
-
-    return value;
+	NSString *value = [self findProperty:propName withPrefix:prefix];
+	
+	if (value.length == 0) {
+		value = [self findProperty:propName withPrefix:@""];
+	}
+	
+	return value;
 }
 
 
 - (NSString *)findProperty:(NSString *)propName withPrefix:(NSString *)prefix {
-    auto prop = m_package->PropertyMatching([propName UTF8String], [prefix UTF8String]);
-
-    if (prop != nullptr) {
-        return [NSString stringWithUTF8String:prop->Value().c_str()];
-    }
-
-    return @"";
+	auto prop = m_package->PropertyMatching([propName UTF8String], [prefix UTF8String]);
+	
+	if (prop != nullptr) {
+		return [NSString stringWithUTF8String:prop->Value().c_str()];
+	}
+	
+	return @"";
 }
 
 - (NSString *)renditionLayout {
-    return [self findProperty:@"layout" withPrefix:@"rendition"];
+	return [self findProperty:@"layout" withPrefix:@"rendition"];
 }
 - (NSString *)renditionFlow {
-    return [self findProperty:@"flow" withPrefix:@"rendition"];
+	return [self findProperty:@"flow" withPrefix:@"rendition"];
 }
 - (NSString *)renditionSpread {
-    return [self findProperty:@"spread" withPrefix:@"rendition"];
+	return [self findProperty:@"spread" withPrefix:@"rendition"];
 }
 - (NSString *)renditionOrientation {
-    return [self findProperty:@"orientation" withPrefix:@"rendition"];
+	return [self findProperty:@"orientation" withPrefix:@"rendition"];
 }
 
 
 - (RDPackageResource *)resourceAtRelativePath:(NSString *)relativePath {
 	if (relativePath == nil || relativePath.length == 0) {
 		return nil;
 	}
-
+	
 	NSRange range = [relativePath rangeOfString:@"#"];
-
+	
 	if (range.location != NSNotFound) {
 		relativePath = [relativePath substringToIndex:range.location];
 	}
-
+	
 	ePub3::string s = ePub3::string(relativePath.UTF8String);
 	std::unique_ptr<ePub3::ByteStream> byteStream = m_package->ReadStreamForRelativePath(s);
-
-	if (byteStream == nullptr) {
-		NSLog(@"Relative path '%@' does not have a byte stream!", relativePath);
+	if (byteStream == nullptr)
+	{
+		NSLog(@"Relative path '%@' is not present in the book.", relativePath);
 		return nil;
 	}
-
+
+	ePub3::ConstManifestItemPtr manifestItem = m_package->ManifestItemAtRelativePath(s);
+	if (manifestItem == nullptr) {
+		NSLog(@"Relative path '%@' does not have a manifest item!", relativePath);
+		return nil;
+	}
+
 	RDPackageResource *resource = [[RDPackageResource alloc]
-		initWithDelegate:self
-		byteStream:byteStream.get()
-		package:self
-		relativePath:relativePath];
-
+								   initWithByteStream:byteStream.release()
+								   package:self
+								   relativePath:relativePath];
+
 	if (resource != nil) {
-		m_byteStreamVector.push_back(std::move(byteStream));
-		ePub3::ConstManifestItemPtr item = m_package->ManifestItemAtRelativePath(s);
-
-		if (item) {
-			const ePub3::ManifestItem::MimeType &mediaType = item->MediaType();
-			resource.mimeType = [NSString stringWithUTF8String:mediaType.c_str()];
-		}
+		const ePub3::ManifestItem::MimeType &mediaType = manifestItem->MediaType();
+		resource.mimeType = [NSString stringWithUTF8String:mediaType.c_str()];
 	}
-
+	
 	return resource;
 }
 
@@ -397,4 +384,47 @@ - (NSString *)title {
 }
 
 
+- (void *)getProperByteStream:(NSString *)relativePath currentByteStream:(void *)currentByteStream isRangeRequest:(BOOL)isRangeRequest {
+	if (relativePath == nil || relativePath.length == 0) {
+		return nil;
+	}
+
+	NSRange range = [relativePath rangeOfString:@"#"];
+
+	if (range.location != NSNotFound) {
+		relativePath = [relativePath substringToIndex:range.location];
+	}
+	ePub3::string s = ePub3::string(relativePath.UTF8String);
+
+	ePub3::ConstManifestItemPtr manifestItem = m_package->ManifestItemAtRelativePath(s);
+	if (manifestItem == nullptr) {
+		NSLog(@"Relative path '%@' does not have a manifest item!", relativePath);
+		return nil;
+	}
+	ePub3::ManifestItemPtr m = std::const_pointer_cast<ePub3::ManifestItem>(manifestItem);
+
+	size_t numFilters = m_package->GetFilterChainSize(m);
+	ePub3::ByteStream *byteStream = nullptr;
+	ePub3::SeekableByteStream *rawInput = dynamic_cast<ePub3::SeekableByteStream *>((ePub3::ByteStream *)currentByteStream);
+
+	if (numFilters == 0)
+	{
+		byteStream = (ePub3::ByteStream *) currentByteStream; // is actually a SeekableByteStream
+	}
+	else if (numFilters == 1 && isRangeRequest)
+	{
+		byteStream = m_package->GetFilterChainByteStreamRange(m, rawInput).release(); // is *not* a SeekableByteStream, but wraps one
+		if (byteStream == nullptr)
+		{
+			byteStream = m_package->GetFilterChainByteStream(m, rawInput).release(); // is *not* a SeekableByteStream, but wraps one
+		}
+	}
+	else
+	{
+		byteStream = m_package->GetFilterChainByteStream(m, rawInput).release(); // is *not* a SeekableByteStream, but wraps one
+	}
+
+	return byteStream;
+}
+
 @end

Platform/Apple/RDServices/Main/RDPackageResource.h

@@ -32,30 +32,22 @@
 @class RDPackage;
 @class RDPackageResource;
 
-@protocol RDPackageResourceDelegate <NSObject>
-
-- (void)packageResourceWillDeallocate:(RDPackageResource *)packageResource;
-
-@end
-
 @interface RDPackageResource : NSObject
 
 @property (nonatomic, readonly) void *byteStream;
 @property (nonatomic, readonly) NSUInteger contentLength;
-@property (nonatomic, readonly) NSData *data;
 @property (nonatomic, copy) NSString *mimeType;
 @property (nonatomic, readonly) RDPackage *package;
 
 // The relative path associated with this resource.
 @property (nonatomic, readonly) NSString *relativePath;
 
 - (instancetype)
-	initWithDelegate:(id <RDPackageResourceDelegate>)delegate
-	byteStream:(void *)byteStream
+	initWithByteStream:(void *)byteStream
 	package:(RDPackage *)package
 	relativePath:(NSString *)relativePath;
 
-- (NSData *)readDataOfLength:(NSUInteger)length;
-- (void)setOffset:(UInt64)offset;
+- (NSData *)readDataFull;
+- (NSData *)readDataOfLength:(NSUInteger)length offset:(UInt64)offset isRangeRequest:(BOOL)isRangeRequest;
 
 @end