[core][node] Support ImageSource #8968

asheemmamoowala · 2017-05-12T00:00:34Z

Add support for ImageSource to mbgl-core. The current source passes existing render tests and can be verified with the macos app/mbgl-glfw.

Remaining Tasks

Improve render transform
Fix image flip when crossing date line 🙃
ImageSource API improvements
~~iOS/Android/Qt Bindings ? ⛷~~ (Working on a separate PR)
Offline support
rebase 💥

//cc @jfirebaugh @ivovandongen @kkaefer

jfirebaugh · 2017-05-12T16:15:42Z

cmake/core-files.cmake

    src/mbgl/renderer/tile_parameters.hpp
    src/mbgl/renderer/tile_pyramid.cpp
    src/mbgl/renderer/tile_pyramid.hpp
    src/mbgl/renderer/transitioning_property.hpp
    src/mbgl/renderer/update_parameters.hpp

+    # renderer/buckets


👍 on subdirectories for buckets and layer. Can you submit that as an independent PR so that it's easily reviewable independently? Will also help minimize potential merge conflicts as these files are getting touched a lot right now.

jfirebaugh · 2017-05-12T16:16:19Z

include/mbgl/style/conversion/coordinate.hpp

+namespace conversion {
+
+template<>
+struct Converter<std::unique_ptr<LatLng>> {


No need for unique_ptr here; LatLng is a value class.

jfirebaugh · 2017-05-12T16:19:34Z

include/mbgl/util/geo.hpp

@@ -47,7 +47,7 @@ class LatLng {
            wrap();
        }
    }
-
+    


Nit: whitespace change.

jfirebaugh · 2017-05-12T16:20:23Z

platform/default/mbgl/storage/offline_download.cpp

@@ -107,6 +107,7 @@ OfflineRegionStatus OfflineDownload::getStatus() const {

        case SourceType::Video:
        case SourceType::Annotations:
+        case SourceType::Image:
            break;


We'll need to add offline support for image sources -- it should download and store the image in the offline database.

Offline support added in 3506bb5

jfirebaugh · 2017-05-12T16:20:35Z

platform/default/mbgl/storage/offline_download.cpp

@@ -176,7 +177,8 @@ void OfflineDownload::activateDownload() {

            case SourceType::Video:
            case SourceType::Annotations:
-                break;
+            case SourceType::Image:
+                    break;


Whitespace.

kkaefer · 2017-05-15T09:45:46Z

cmake/core-files.cmake

@@ -74,6 +74,8 @@ set(MBGL_CORE_FILES
    src/mbgl/gl/object.hpp
    src/mbgl/gl/primitives.hpp
    src/mbgl/gl/program.hpp
+    src/mbgl/gl/program_binary.cpp
+    src/mbgl/gl/program_binary.hpp


Bogus file add

kkaefer · 2017-05-15T09:46:15Z

include/mbgl/style/conversion/coordinate.hpp

+        }
+        //Style spec uses GeoJSON convention for specifying coordinates
+        optional<float> latitude = toNumber(arrayMember(value, 1));
+        optional<float> longitude = toNumber(arrayMember(value, 0));


These can be const

kkaefer · 2017-05-15T09:47:20Z

include/mbgl/style/conversion/source.hpp

+
+        std::vector<std::unique_ptr<LatLng>> coordinates;
+        coordinates.reserve(4);
+        for( std::size_t i=0; i < arrayLength(*coordinatesValue); i++) {


Whitespace: We're using for (std::size_t i = 0; i < arrayLength(*coordinatesValue); i++) {

kkaefer · 2017-05-15T09:47:52Z

include/mbgl/style/conversion/source.hpp

+            return {};
+        }
+
+        auto result = std::make_unique<ImageSource>(id, *urlString);


We could move the string into the constructor

kkaefer · 2017-05-15T09:48:57Z

src/mbgl/style/sources/image_source.cpp

+             return impl->getURL();
+        }
+
+    } // namespace style


Nit: We're not indenting namespaces

kkaefer · 2017-05-15T10:01:37Z

src/mbgl/renderer/render_item.hpp

-    const RenderLayer& layer;
-    std::vector<std::reference_wrapper<RenderTile>> tiles;
+    RenderLayer& layer;
+    RenderSource * source;


Whitespace: RenderSource* source;

kkaefer · 2017-05-15T10:02:42Z

src/mbgl/renderer/sources/render_image_source.cpp

+: RenderSource(impl_),
+ impl(impl_),
+ loaded(false) {
+}


kkaefer · 2017-05-15T10:11:35Z

src/mbgl/renderer/sources/render_image_source.hpp

+                     const mat4& clipMatrix,
+                     const TransformState&) final;
+
+    void render      (Painter&, PaintParameters& , const RenderLayer& ) ;


Whitespace ;)

kkaefer · 2017-05-15T10:12:32Z

src/mbgl/style/sources/image_source_impl.cpp

+    return url;
+}
+
+void ImageSource::Impl::setCoordinates(const std::vector<LatLng> coords_) {


This should be either a non-const value (to enable move), or a const & to avoid two copies.

kkaefer · 2017-05-15T10:16:54Z

test/src/mbgl/test/conversion_stubs.hpp

+    } else {
+        return {};
+    }
+    return {};


Unreachable code

incanus · 2017-05-25T22:18:51Z

include/mbgl/style/sources/image_source.hpp

+
+class ImageSource : public Source {
+public:
+    ImageSource(std::string id, const std::vector<LatLng>);


How come this isn't a LatLngBounds? Similarly, it's very hard to discern the coordinate order this way.

Apparently an image source can be associated with any quadrilateral, not necessarily a rectangle.

mbgl tends to use std::array to represent fixed-length collections in style values (cf. padding and offsets). As @incanus points out, a struct with named fields would be another option that would avoid corner-swapping problems, although maybe we could make it so that the input order doesn’t matter.

@incanus - thats an excellent point. Ive tried to wrap around that in the SDKs in the draft API PR. If the Quad struct makes sense, I think it might make more sense to move it into native.

Note that there would have to be separate types for mbgl and for the iOS/macOS SDK, because the iOS/macOS SDKs can’t expose any C++ to the public.

mbgl tends to use std::array to represent fixed-length collections

Correct -- the type should be std::array<LatLng, 4>.

incanus · 2017-05-25T23:27:14Z

Quick & dirty iOS bindings for a near-term use case I have, per chat with @asheemmamoowala:

1350-image-source...jrm-ios-image-source-hack

…oordinates

jfirebaugh

Getting close! In addition to the changes requested below, please enable the relevant integration tests in mapbox-gl-js, open a PR there, and update the submodule pin here.

jfirebaugh · 2017-05-30T22:05:06Z

include/mbgl/style/conversion/coordinate.hpp

+    template <class V>
+    optional<LatLng> operator() (const V& value, Error& error) const {
+        if (!isArray(value) || arrayLength(value) < 2 ) {
+            error = { "coordinate array must contain numeric longtitude and latitude values" };


Typo for "longitude".

jfirebaugh · 2017-05-30T22:06:28Z

include/mbgl/style/conversion/source.hpp

+
+        std::vector<LatLng> coordinates;
+        coordinates.reserve(4);
+        for( std::size_t i=0; i < arrayLength(*coordinatesValue); i++) {


Nit: whitespace. Also can use fixed upper bound. for (std::size_t i = 0; i < 4; i++)

jfirebaugh · 2017-05-30T22:08:57Z

include/mbgl/style/sources/image_source.hpp

+
+class ImageSource : public Source {
+public:
+    ImageSource(std::string id, const std::vector<LatLng>);


mbgl tends to use std::array to represent fixed-length collections

Correct -- the type should be std::array<LatLng, 4>.

jfirebaugh · 2017-05-30T22:10:36Z

platform/android/src/style/android_conversion.hpp

@@ -66,6 +66,15 @@ inline optional<float> toNumber(const mbgl::android::Value& value) {
    }
 }

+inline optional<double> toDouble(const mbgl::android::Value& value) {
+    if (value.isNumber()) {
+        auto num = value.toDouble();


return value.toDouble();

jfirebaugh · 2017-05-30T22:12:34Z

include/mbgl/style/sources/image_source.hpp

+    ImageSource(std::string id, const std::vector<LatLng>);
+    ~ImageSource() override;
+
+    const std::string& getURL() const;


Return type should be optional<std::string>, matching {Vector,Raster}Source::getURL and reflecting the possibility of absence.

jfirebaugh · 2017-05-30T23:16:44Z

src/mbgl/renderer/sources/render_image_source.cpp

+    setupBucket(geomCoords);
+}
+
+void RenderImageSource::setupBucket(GeometryCoordinates& geomCoords) {


This is only called from updateTiles -- inline it there.

jfirebaugh · 2017-05-30T23:20:53Z

src/mbgl/renderer/sources/render_image_source.hpp

@@ -0,0 +1,71 @@
+#pragma once
+
+#include <mbgl/renderer/buckets/raster_bucket.hpp>


Forward declare RasterBucket (and define ~RenderImageSource in the .cpp file) instead.

jfirebaugh · 2017-05-30T23:23:14Z

src/mbgl/renderer/sources/render_image_source.hpp

+#include <mbgl/renderer/render_source.hpp>
+#include <mbgl/renderer/render_tile.hpp>
+#include <mbgl/style/sources/image_source_impl.hpp>
+#include <mbgl/tile/geometry_tile_data.hpp>


jfirebaugh · 2017-05-30T23:23:19Z

src/mbgl/renderer/sources/render_image_source.hpp

+#include <mbgl/renderer/render_tile.hpp>
+#include <mbgl/style/sources/image_source_impl.hpp>
+#include <mbgl/tile/geometry_tile_data.hpp>
+#include <mbgl/util/image.hpp>


jfirebaugh · 2017-05-30T23:23:29Z

src/mbgl/renderer/sources/render_image_source.hpp

+#include <mbgl/style/sources/image_source_impl.hpp>
+#include <mbgl/tile/geometry_tile_data.hpp>
+#include <mbgl/util/image.hpp>
+#include <mbgl/util/optional.hpp>


1ec5 · 2017-06-01T08:19:34Z

This PR along with #9110 fixes #1350.

jfirebaugh

Good to merge once CI is passing. The current failure is:

==12458== Invalid write of size 4
==12458==    at 0x5D79AF: std::vector<unsigned int, std::allocator<unsigned int> >::push_back(unsigned int const&) (in /home/travis/build/mapbox/mapbox-gl-native/build/qt-linux-x86_64/Release/mbgl-test)
==12458==    by 0x5D7872: mbgl::gl::detail::TextureDeleter::operator()(unsigned int) const (in /home/travis/build/mapbox/mapbox-gl-native/build/qt-linux-x86_64/Release/mbgl-test)
==12458==    by 0x49B1BC: mbgl::RasterBucket::~RasterBucket() (in /home/travis/build/mapbox/mapbox-gl-native/build/qt-linux-x86_64/Release/mbgl-test)
==12458==    by 0x498189: Buckets_RasterBucket_Test::TestBody() (in /home/travis/build/mapbox/mapbox-gl-native/build/qt-linux-x86_64/Release/mbgl-test)

Which indicates that in the RasterBucket test, the declaration order for the bucket and the context should be switched, so that the context is still alive when the bucket is destroyed.

asheemmamoowala added GL JS parity For feature parity with Mapbox GL JS ⚠️ DO NOT MERGE Work in progress, proof of concept, or on hold labels May 12, 2017

asheemmamoowala force-pushed the 1350-image-source branch from d6d17e4 to 32615d4 Compare May 12, 2017 00:33

jfirebaugh reviewed May 12, 2017

View reviewed changes

jfirebaugh suggested changes May 12, 2017

View reviewed changes

kkaefer reviewed May 17, 2017

View reviewed changes

asheemmamoowala force-pushed the 1350-image-source branch 3 times, most recently from 8da5ce5 to ffff1c6 Compare May 18, 2017 23:29

incanus reviewed May 25, 2017

View reviewed changes

incanus added a commit that referenced this pull request May 25, 2017

refs #1350, refs #8968: quick cut of iOS image source bindings

4443eba

[core] Add ImageSource support to style parsers

abd9c9b

asheemmamoowala force-pushed the 1350-image-source branch from ffff1c6 to ffad32a Compare May 27, 2017 00:59

Asheem Mamoowala added 3 commits May 26, 2017 18:00

[core] Add toDouble Conversion method for correctly parsing Lat Lng c…

ea80a96

…oordinates

[core] Offline support for Image Sources

3506bb5

[core] Render Image Source

6d940a9

asheemmamoowala force-pushed the 1350-image-source branch from ffad32a to 6d940a9 Compare May 27, 2017 01:00

kkaefer added Core The cross-platform C++ core, aka mbgl Node.js node-mapbox-gl-native labels May 30, 2017

asheemmamoowala removed the ⚠️ DO NOT MERGE Work in progress, proof of concept, or on hold label May 30, 2017

asheemmamoowala changed the title ~~WIP: [core][node] Support ImageSource~~ [core][node] Support ImageSource May 30, 2017

jfirebaugh suggested changes May 30, 2017

View reviewed changes

Asheem Mamoowala added 2 commits May 31, 2017 16:07

[core] Update gl-js submodule to include ImageSource render tests

f5b5945

[core] Use fixed-size std::array for ImageSource coordinates

8bdff09

1ec5 mentioned this pull request Jun 1, 2017

[ios][android] SDK Bindings for Image Sources #9110

Merged

1ec5 mentioned this pull request Jun 1, 2017

Support "image" source type #1350

Closed

jfirebaugh approved these changes Jun 1, 2017

View reviewed changes

[core] Reuse RasterBucket for ImageSource

91f2a9b

asheemmamoowala force-pushed the 1350-image-source branch from 989918b to 91f2a9b Compare June 1, 2017 18:52

[core] Add templated RTTI for RenderSource classes

de2b1ca

asheemmamoowala merged commit 2652a4a into master Jun 1, 2017

asheemmamoowala deleted the 1350-image-source branch June 1, 2017 22:44

This was referenced Jun 2, 2017

Enable ImageSource integration tests for Native mapbox/mapbox-gl-js#4774

Merged

Label legibility improvements: pitch-scaling and pitched line-following #9009

Merged

@@ @@ -47,7 +47,7 @@ class LatLng { @@
                           wrap();
                       }
                   }

		@@ -0,0 +1,71 @@
		#pragma once

		#include <mbgl/renderer/buckets/raster_bucket.hpp>

[core][node] Support ImageSource #8968

[core][node] Support ImageSource #8968

Conversation

asheemmamoowala commented May 12, 2017 • edited Loading

Remaining Tasks

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

incanus May 25, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

incanus commented May 25, 2017

jfirebaugh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ec5 commented Jun 1, 2017

jfirebaugh left a comment

Choose a reason for hiding this comment

asheemmamoowala commented May 12, 2017 •

edited

Loading

incanus May 25, 2017 •

edited

Loading