Rebased iOS Metal support branch

benchmark/CMakeLists.txt

@@ -28,13 +28,11 @@ include(${PROJECT_SOURCE_DIR}/vendor/benchmark.cmake)
 
 if(CMAKE_SYSTEM_NAME STREQUAL iOS)
     set_target_properties(mbgl-vendor-benchmark PROPERTIES XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET "${IOS_DEPLOYMENT_TARGET}")
-    set_target_properties(mbgl-vendor-benchmark PROPERTIES XCODE_ATTRIBUTE_ENABLE_BITCODE "YES")
-    set_target_properties(mbgl-vendor-benchmark PROPERTIES XCODE_ATTRIBUTE_BITCODE_GENERATION_MODE bitcode)
+    set_target_properties(mbgl-vendor-benchmark PROPERTIES XCODE_ATTRIBUTE_ENABLE_BITCODE "NO")
     set_target_properties(mbgl-vendor-benchmark PROPERTIES XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH $<$<CONFIG:Debug>:YES>)
 
     set_target_properties(mbgl-benchmark PROPERTIES XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET "${IOS_DEPLOYMENT_TARGET}")
-    set_target_properties(mbgl-benchmark PROPERTIES XCODE_ATTRIBUTE_ENABLE_BITCODE "YES")
-    set_target_properties(mbgl-benchmark PROPERTIES XCODE_ATTRIBUTE_BITCODE_GENERATION_MODE bitcode)
+    set_target_properties(mbgl-benchmark PROPERTIES XCODE_ATTRIBUTE_ENABLE_BITCODE "NO")
     set_target_properties(mbgl-benchmark PROPERTIES XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH $<$<CONFIG:Debug>:YES>)
 endif()
 

platform/ios/ios.cmake

@@ -14,8 +14,7 @@ set_target_properties(mbgl-core PROPERTIES XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH[vari
 
 macro(initialize_ios_target target)
     set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET "${IOS_DEPLOYMENT_TARGET}")
-    set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_ENABLE_BITCODE "YES")
-    set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_BITCODE_GENERATION_MODE bitcode)
+    set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_ENABLE_BITCODE "NO")
     set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH $<$<CONFIG:Debug>:YES>)
 endmacro()
 

platform/ios/platform/darwin/darwin.xcconfig

@@ -79,7 +79,6 @@ OTHER_CPLUSPLUSFLAGS = $(inherited) -fvisibility=hidden -fcxx-modules
 OTHER_SWIFT_FLAGS = -warnings-as-errors
 
 // User defined
-BITCODE_GENERATION_MODE = bitcode 
 CURRENT_COMMIT_HASH = deadbeef
 CURRENT_SEMANTIC_VERSION = 0.0.0
 CURRENT_SHORT_VERSION = 0.0

platform/ios/platform/darwin/src/MGLOpenGLStyleLayer.h

@@ -11,6 +11,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @class MGLMapView;
 @class MGLStyle;
+@class MGLContext;
 
 typedef struct MGLStyleLayerDrawingContext {
     CGSize size;
@@ -30,7 +31,7 @@ MGL_EXPORT
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
 #if TARGET_OS_IPHONE
-@property (nonatomic, readonly) EAGLContext *context;
+@property (nonatomic, readonly) MGLContext *context;
 #else
 @property (nonatomic, readonly) CGLContextObj context;
 #endif

platform/ios/platform/darwin/src/MGLOpenGLStyleLayer.mm

@@ -76,7 +76,7 @@ - (MGLMapView *)mapView {
 }
 
 #if TARGET_OS_IPHONE
-- (EAGLContext *)context {
+- (MGLContext *)context {
     return self.mapView.context;
 }
 #else

platform/ios/platform/darwin/src/MGLReachability.m

@@ -466,7 +466,7 @@ -(void)reachabilityChanged:(SCNetworkReachabilityFlags)flags
 - (NSString *) description
 {
     NSString *description = [NSString stringWithFormat:@"<%@: %p (%@)>",
-                             NSStringFromClass([self class]), (void *) self, [self currentReachabilityFlags]];
+                             NSStringFromClass([self class]), self, [self currentReachabilityFlags]];
     return description;
 }
 

platform/ios/platform/darwin/src/NSExpression+MGLAdditions.mm

@@ -1291,7 +1291,7 @@ - (id)mgl_jsonExpressionObject {
                 }
 
                 return self.arguments.mgl_jsonExpressionObject;
-            } else if (op == (NSString *) [MGLColor class] && [function isEqualToString:@"colorWithRed:green:blue:alpha:"]) {
+            } else if ([function isEqualToString:@"colorWithRed:green:blue:alpha:"]) {
                 NSArray *arguments = self.arguments.mgl_jsonExpressionObject;
                 return [@[@"rgba"] arrayByAddingObjectsFromArray:arguments];
             } else if ([function isEqualToString:@"median:"] ||

platform/ios/platform/ios/config.cmake

@@ -2,8 +2,7 @@ set(USE_GLES2 ON)
 
 macro(initialize_ios_target target)
     set_xcode_property(${target} IPHONEOS_DEPLOYMENT_TARGET "9.0")
-    set_xcode_property(${target} ENABLE_BITCODE "YES")
-    set_xcode_property(${target} BITCODE_GENERATION_MODE bitcode)
+    set_xcode_property(${target} ENABLE_BITCODE "NO")
     set_xcode_property(${target} ONLY_ACTIVE_ARCH $<$<CONFIG:Debug>:YES>)
 
     target_compile_options(${target}

platform/ios/platform/ios/scripts/package.sh

@@ -247,10 +247,10 @@ if [[ ${BUILD_STATIC} == true ]]; then
     mkdir "${OUTPUT}/static/${NAME}.framework/Modules"
     cp -pv platform/ios/framework/modulemap "${OUTPUT}/static/${NAME}.framework/Modules/module.modulemap"
 fi
-if [[ ${BUILD_DYNAMIC} == true && ${BUILD_FOR_DEVICE} == true ]]; then
-    step "Copying bitcode symbol maps…"
-    find "${PRODUCTS}/${BUILDTYPE}-iphoneos" -name '*.bcsymbolmap' -type f -exec cp -pv {} "${OUTPUT}/dynamic/" \;
-fi
+#if [[ ${BUILD_DYNAMIC} == true && ${BUILD_FOR_DEVICE} == true ]]; then
+#    step "Copying bitcode symbol maps…"
+#    find "${PRODUCTS}/${BUILDTYPE}-iphoneos" -name '*.bcsymbolmap' -type f -exec cp -pv {} "${OUTPUT}/dynamic/" \;
+#fi
 sed -n -e '/^## /,$p' platform/ios/CHANGELOG.md > "${OUTPUT}/CHANGELOG.md"
 
 rm -rf /tmp/mbgl

platform/ios/platform/ios/src/MGLMapView+Impl.h

@@ -6,6 +6,8 @@
 #import <UIKit/UIImage.h>
 #import <QuartzCore/CALayer.h>
 
+#import <MetalANGLE/MGLContext.h>
+
 @class MGLMapView;
 
 class MGLMapViewImpl : public mbgl::MapObserver {
@@ -18,7 +20,7 @@ class MGLMapViewImpl : public mbgl::MapObserver {
     virtual mbgl::gfx::RendererBackend& getRendererBackend() = 0;
 
     // Returns a handle to the OpenGL context object if this view is rendered with OpenGL.
-    virtual EAGLContext* getEAGLContext() {
+    virtual MGLContext* getEAGLContext() {
         return nullptr;
     }
 

platform/ios/platform/ios/src/MGLMapView+OpenGL.h

@@ -17,11 +17,6 @@ class MGLMapViewOpenGLImpl final : public MGLMapViewImpl,
 public:
     void restoreFramebufferBinding();
 
-#ifdef MGL_RECREATE_GL_IN_AN_EMERGENCY
-private:
-    void emergencyRecreateGL();
-#endif
-
     // Implementation of mbgl::gfx::RendererBackend
 public:
     mbgl::gfx::Renderable& getDefaultRenderable() override {
@@ -47,7 +42,7 @@ class MGLMapViewOpenGLImpl final : public MGLMapViewImpl,
         return *this;
     }
 
-    EAGLContext* getEAGLContext() override;
+    MGLContext* getEAGLContext() override;
     void setOpaque(bool) override;
     void display() override;
     void setPresentsWithTransaction(bool) override;

platform/ios/platform/ios/src/MGLMapView+OpenGL.mm

@@ -4,11 +4,7 @@
 
 #include <mbgl/gl/renderable_resource.hpp>
 
-#import <GLKit/GLKit.h>
-#import <OpenGLES/EAGL.h>
-#import <QuartzCore/CAEAGLLayer.h>
-
-@interface MGLMapViewImplDelegate : NSObject <GLKViewDelegate>
+@interface MGLMapViewImplDelegate : NSObject <MGLKViewDelegate>
 @end
 
 @implementation MGLMapViewImplDelegate {
@@ -22,7 +18,7 @@ - (instancetype)initWithImpl:(MGLMapViewOpenGLImpl*)impl {
     return self;
 }
 
-- (void)glkView:(nonnull GLKView*)view drawInRect:(CGRect)rect {
+- (void)mglkView:(MGLKView *)view drawInRect:(CGRect)rect {
     _impl->render();
 }
 
@@ -60,8 +56,8 @@ void bind() override {
 
 public:
     MGLMapViewImplDelegate* delegate = nil;
-    GLKView *glView = nil;
-    EAGLContext *context = nil;
+    MGLKView *glView = nil;
+    MGLContext *context = nil;
     const bool atLeastiOS_12_2_0;
 
     // We count how often the context was activated/deactivated so that we can truly deactivate it
@@ -77,8 +73,8 @@ void bind() override {
 
 MGLMapViewOpenGLImpl::~MGLMapViewOpenGLImpl() {
     auto& resource = getResource<MGLMapViewOpenGLRenderableResource>();
-    if (resource.context && [[EAGLContext currentContext] isEqual:resource.context]) {
-        [EAGLContext setCurrentContext:nil];
+    if (resource.context && [[MGLContext currentContext] isEqual:resource.context]) {
+        [MGLContext setCurrentContext:nil];
     }
 }
 
@@ -89,22 +85,30 @@ void bind() override {
 }
 
 void MGLMapViewOpenGLImpl::setPresentsWithTransaction(const bool value) {
-    auto& resource = getResource<MGLMapViewOpenGLRenderableResource>();
-    CAEAGLLayer* eaglLayer = MGL_OBJC_DYNAMIC_CAST(resource.glView.layer, CAEAGLLayer);
-    eaglLayer.presentsWithTransaction = value;
+    // No-op on Metal.
 }
 
 void MGLMapViewOpenGLImpl::display() {
     auto& resource = getResource<MGLMapViewOpenGLRenderableResource>();
 
-    // Calling `display` here directly causes the stuttering bug (if
-    // `presentsWithTransaction` is `YES` - see above)
-    // as reported in https://github.com/mapbox/mapbox-gl-native-ios/issues/350
-    //
-    // Since we use `presentsWithTransaction` to synchronize with UIView
-    // annotations, we now let the system handle when the view is rendered. This
-    // has the potential to increase latency
-    [resource.glView setNeedsDisplay];
+    // See https://github.com/mapbox/mapbox-gl-native/issues/14232
+    // glClear can be blocked for 1 second. This code is an "escape hatch",
+    // an attempt to detect this situation and rebuild the GL views.
+    if (mapView.enablePresentsWithTransaction && resource.atLeastiOS_12_2_0) {
+        CFTimeInterval before = CACurrentMediaTime();
+        [resource.glView display];
+        CFTimeInterval after = CACurrentMediaTime();
+
+        if (after - before >= 1.0) {
+#ifdef MGL_RECREATE_GL_IN_AN_EMERGENCY
+            dispatch_async(dispatch_get_main_queue(), ^{
+              emergencyRecreateGL();
+            });
+#endif
+        }
+    } else {
+        [resource.glView display];
+    }
 }
 
 void MGLMapViewOpenGLImpl::createView() {
@@ -114,22 +118,21 @@ void bind() override {
     }
 
     if (!resource.context) {
-        resource.context = [[EAGLContext alloc] initWithAPI:kEAGLRenderingAPIOpenGLES2];
+        resource.context = [[MGLContext alloc] initWithAPI:kMGLRenderingAPIOpenGLES2];
         assert(resource.context);
     }
 
-    resource.glView = [[GLKView alloc] initWithFrame:mapView.bounds context:resource.context];
+    resource.glView = [[MGLKView alloc] initWithFrame:mapView.bounds context:resource.context];
     resource.glView.delegate = resource.delegate;
     resource.glView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
     resource.glView.contentScaleFactor = contentScaleFactor();
     resource.glView.contentMode = UIViewContentModeCenter;
-    resource.glView.drawableStencilFormat = GLKViewDrawableStencilFormat8;
-    resource.glView.drawableDepthFormat = GLKViewDrawableDepthFormat16;
+    resource.glView.drawableStencilFormat = MGLDrawableStencilFormat8;
+    resource.glView.drawableDepthFormat = MGLDrawableDepthFormat16;
     resource.glView.opaque = mapView.opaque;
     resource.glView.layer.opaque = mapView.opaque;
-    resource.glView.enableSetNeedsDisplay = YES;
-    CAEAGLLayer* eaglLayer = MGL_OBJC_DYNAMIC_CAST(resource.glView.layer, CAEAGLLayer);
-    eaglLayer.presentsWithTransaction = NO;
+    resource.glView.layer.sublayers.firstObject.zPosition = -10;
+    resource.glView.enableSetNeedsDisplay = NO;
 
     [mapView insertSubview:resource.glView atIndex:0];
 }
@@ -140,51 +143,9 @@ void bind() override {
 }
 
 void MGLMapViewOpenGLImpl::deleteView() {
-    auto& resource = getResource<MGLMapViewOpenGLRenderableResource>();
-    [resource.glView deleteDrawable];
+    // No-op on Metal
 }
 
-#ifdef MGL_RECREATE_GL_IN_AN_EMERGENCY
-// TODO: Fix or remove
-// See https://github.com/mapbox/mapbox-gl-native/issues/14232
-void MGLMapViewOpenGLImpl::emergencyRecreateGL() {
-    auto& resource = getResource<MGLMapViewOpenGLRenderableResource>();
-    MGLLogError(@"Rendering took too long - creating GL views");
-
-    CAEAGLLayer* eaglLayer = MGL_OBJC_DYNAMIC_CAST(resource.glView.layer, CAEAGLLayer);
-    eaglLayer.presentsWithTransaction = NO;
-
-    [mapView pauseRendering:nil];
-
-    // Just performing a pauseRendering:/resumeRendering: pair isn't sufficient - in this case
-    // we can still get errors when calling bindDrawable. Here we completely
-    // recreate the GLKView
-
-    [mapView.userLocationAnnotationView removeFromSuperview];
-    [resource.glView removeFromSuperview];
-
-    // Recreate the view
-    resource.glView = nil;
-    createView();
-
-    if (mapView.annotationContainerView) {
-        [resource.glView insertSubview:mapView.annotationContainerView atIndex:0];
-    }
-
-    [mapView updateUserLocationAnnotationView];
-
-    // Do not bind...yet
-
-    if (mapView.window) {
-        [mapView resumeRendering:nil];
-        eaglLayer = MGL_OBJC_DYNAMIC_CAST(resource.glView.layer, CAEAGLLayer);
-        eaglLayer.presentsWithTransaction = mapView.enablePresentsWithTransaction;
-    } else {
-        MGLLogDebug(@"No window - skipping resumeRendering");
-    }
-}
-#endif
-
 mbgl::gl::ProcAddress MGLMapViewOpenGLImpl::getExtensionFunctionPointer(const char* name) {
     static CFBundleRef framework = CFBundleGetBundleWithIdentifier(CFSTR("com.apple.opengles"));
     if (!framework) {
@@ -201,7 +162,7 @@ void bind() override {
         return;
     }
 
-    [EAGLContext setCurrentContext:resource.context];
+    [MGLContext setCurrentContext:resource.context];
 }
 
 void MGLMapViewOpenGLImpl::deactivate() {
@@ -210,7 +171,7 @@ void bind() override {
         return;
     }
 
-    [EAGLContext setCurrentContext:nil];
+    [MGLContext setCurrentContext:nil];
 }
 
 /// This function is called before we start rendering, when iOS invokes our rendering method.
@@ -248,7 +209,7 @@ void bind() override {
              static_cast<uint32_t>(mapView.bounds.size.height * scaleFactor) };
 }
 
-EAGLContext* MGLMapViewOpenGLImpl::getEAGLContext() {
+MGLContext* MGLMapViewOpenGLImpl::getEAGLContext() {
     auto& resource = getResource<MGLMapViewOpenGLRenderableResource>();
     return resource.context;
 }