Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
Refactor Android render loop to limit frame rate to 60 FPS
Browse files Browse the repository at this point in the history 
Move expensive cache size calulation to initialisation
Fix setGestureInProgress bug
Renamed several functions to match current usage
Refactor map updates to reduce GPS marker lag
Fixes #1676
Fixes #2290
Fixes #2396
  • Loading branch information
Leith Bade committed Sep 24, 2015
1 parent e5ff463 commit 85ec3eb
Show file tree
Hide file tree
Showing 5 changed files with 97 additions and 91 deletions.
8 changes: 4 additions & 4 deletions android/cpp/jni.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -470,11 +470,11 @@ void JNICALL nativeUpdate(JNIEnv *env, jobject obj, jlong nativeMapViewPtr) {
nativeMapView->getMap().update(mbgl::Update::Repaint);
}

void JNICALL nativeOnInvalidate(JNIEnv *env, jobject obj, jlong nativeMapViewPtr) {
mbgl::Log::Debug(mbgl::Event::JNI, "nativeOnInvalidate");
void JNICALL nativeRenderSync(JNIEnv *env, jobject obj, jlong nativeMapViewPtr) {
mbgl::Log::Debug(mbgl::Event::JNI, "nativeRenderSync");
assert(nativeMapViewPtr != 0);
NativeMapView *nativeMapView = reinterpret_cast<NativeMapView *>(nativeMapViewPtr);
nativeMapView->onInvalidate();
nativeMapView->renderSync();
}

void JNICALL nativeViewResize(JNIEnv *env, jobject obj, jlong nativeMapViewPtr, jint width, jint height) {
Expand Down Expand Up @@ -1625,7 +1625,7 @@ extern "C" JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *reserved) {
{"nativePause", "(J)V", reinterpret_cast<void *>(&nativePause)},
{"nativeResume", "(J)V", reinterpret_cast<void *>(&nativeResume)},
{"nativeUpdate", "(J)V", reinterpret_cast<void *>(&nativeUpdate)},
{"nativeOnInvalidate", "(J)V", reinterpret_cast<void *>(&nativeOnInvalidate)},
{"nativeRenderSync", "(J)V", reinterpret_cast<void *>(&nativeRenderSync)},
{"nativeViewResize", "(JII)V",
reinterpret_cast<void *>(static_cast<void JNICALL (
*)(JNIEnv *, jobject, jlong, jint, jint)>(&nativeViewResize))},
Expand Down
33 changes: 14 additions & 19 deletions android/cpp/native_map_view.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ NativeMapView::NativeMapView(JNIEnv *env, jobject obj_, float pixelRatio_, int a
fileSource = std::make_unique<mbgl::DefaultFileSource>(fileCache.get());
map = std::make_unique<mbgl::Map>(*this, *fileSource, MapMode::Continuous);

float zoomFactor = map->getMaxZoom() - map->getMinZoom() + 1;
float cpuFactor = availableProcessors;
float memoryFactor = static_cast<float>(totalMemory) / 1000.0f / 1000.0f / 1000.0f;
float sizeFactor = (static_cast<float>(map->getWidth()) / mbgl::util::tileSize) *
(static_cast<float>(map->getHeight()) / mbgl::util::tileSize);

size_t cacheSize = zoomFactor * cpuFactor * memoryFactor * sizeFactor * 0.5f;

map->setSourceTileCacheSize(cacheSize);

map->pause();
}

Expand Down Expand Up @@ -148,8 +158,6 @@ void NativeMapView::deactivate() {
void NativeMapView::invalidate() {
mbgl::Log::Debug(mbgl::Event::Android, "NativeMapView::invalidate()");

clean.clear();

assert(vm != nullptr);
assert(obj != nullptr);

Expand All @@ -169,7 +177,7 @@ void NativeMapView::beforeRender() {
}

void NativeMapView::afterRender() {
mbgl::Log::Debug(mbgl::Event::Android, "NativeMapView::swap");
mbgl::Log::Debug(mbgl::Event::Android, "NativeMapView::afterRender");

if ((display != EGL_NO_DISPLAY) && (surface != EGL_NO_SURFACE)) {
if (!eglSwapBuffers(display, surface)) {
Expand Down Expand Up @@ -701,28 +709,15 @@ void NativeMapView::updateFps() {
detach_jni_thread(vm, &env, detach);
}

void NativeMapView::onInvalidate() {
mbgl::Log::Debug(mbgl::Event::Android, "NativeMapView::onInvalidate()");
void NativeMapView::renderSync() {
mbgl::Log::Debug(mbgl::Event::Android, "NativeMapView::renderSync()");

if (map->isPaused()) {
mbgl::Log::Debug(mbgl::Event::Android, "Not rendering as map is paused");
return;
}

const bool dirty = !clean.test_and_set();
if (dirty) {
float zoomFactor = map->getMaxZoom() - map->getMinZoom() + 1;
float cpuFactor = availableProcessors;
float memoryFactor = static_cast<float>(totalMemory) / 1000.0f / 1000.0f / 1000.0f;
float sizeFactor = (static_cast<float>(map->getWidth()) / mbgl::util::tileSize) *
(static_cast<float>(map->getHeight()) / mbgl::util::tileSize);

size_t cacheSize = zoomFactor * cpuFactor * memoryFactor * sizeFactor * 0.5f;

map->setSourceTileCacheSize(cacheSize);

map->renderSync();
}
map->renderSync();
}

void NativeMapView::resizeView(int w, int h) {
Expand Down
137 changes: 75 additions & 62 deletions android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/views/MapView.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import android.support.v4.view.ScaleGestureDetectorCompat;
import android.support.v7.app.AlertDialog;
import android.text.TextUtils;
import android.util.Log;
import android.view.GestureDetector;
import android.view.Gravity;
import android.view.ScaleGestureDetector;
Expand Down Expand Up @@ -63,7 +64,7 @@
import com.mapzen.android.lost.api.LocationRequest;
import com.mapzen.android.lost.api.LocationServices;
import com.mapzen.android.lost.api.LostApiClient;
import com.squareup.okhttp.HttpUrl;

import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.Arrays;
Expand Down Expand Up @@ -138,6 +139,9 @@ public class MapView extends FrameLayout implements LocationListener {
// Used to call JNI NativeMapView
private NativeMapView mNativeMapView;

// Used to track rendering
private Boolean mDirty = false;

// Used to handle DPI scaling
private float mScreenDensity = 1.0f;

Expand Down Expand Up @@ -400,6 +404,12 @@ private void initialize(Context context, AttributeSet attrs) {
.setSmallestDisplacement(1)
.setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY);

// Setup User Location UI
mGpsMarker = new ImageView(getContext());
mGpsMarker.setImageResource(R.drawable.location_marker);
mGpsMarker.setVisibility(View.INVISIBLE);
addView(mGpsMarker);

// Setup Compass
mSensorManager = (SensorManager) mContext.getSystemService(Context.SENSOR_SERVICE);
mSensorAccelerometer = mSensorManager.getDefaultSensor(Sensor.TYPE_ACCELEROMETER);
Expand All @@ -411,6 +421,7 @@ private void initialize(Context context, AttributeSet attrs) {
mCompassView.setContentDescription(getResources().getString(R.string.compassContentDescription));
LayoutParams lp = new FrameLayout.LayoutParams((int)(48 * mScreenDensity), (int)(48 * mScreenDensity));
mCompassView.setLayoutParams(lp);
mCompassView.setVisibility(View.INVISIBLE);
addView(mCompassView);
mCompassView.setOnClickListener(new CompassOnClickListener());

Expand Down Expand Up @@ -883,7 +894,9 @@ public void onCreate(Bundle savedInstanceState) {
addOnMapChangedListener(new OnMapChangedListener() {
@Override
public void onMapChanged(MapChange change) {
updateMap(change);
if (change.equals(MapChange.MapChangeRegionWillChange) || change.equals(MapChange.MapChangeRegionWillChangeAnimated)) {
deselectAnnotation();
}
}
});
}
Expand Down Expand Up @@ -957,7 +970,7 @@ public void onPause() {

if (mIsMyLocationEnabled) {
toggleGps(false);
};
}

mNativeMapView.pause();
}
Expand Down Expand Up @@ -1074,7 +1087,8 @@ private void zoom(boolean zoomIn, float x, float y) {
@Override
public boolean onTouchEvent(@NonNull MotionEvent event) {
// Check and ignore non touch or left clicks
if ((android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH) && (event.getButtonState() != 0) && (event.getButtonState() != MotionEvent.BUTTON_PRIMARY)) {

if ((event.getButtonState() != 0) && (event.getButtonState() != MotionEvent.BUTTON_PRIMARY)) {
return false;
}

Expand Down Expand Up @@ -1103,7 +1117,6 @@ public boolean onTouchEvent(@NonNull MotionEvent event) {
long tapInterval = event.getEventTime() - event.getDownTime();
boolean isTap = tapInterval <= ViewConfiguration.getTapTimeout();
boolean inProgress = mRotateGestureDetector.isInProgress() || mScaleGestureDetector.isInProgress();
mNativeMapView.setGestureInProgress(false);

if (mTwoTap && isTap && !inProgress) {
PointF focalPoint = TwoFingerGestureDetector.determineFocalPoint(event);
Expand All @@ -1113,6 +1126,7 @@ public boolean onTouchEvent(@NonNull MotionEvent event) {
}

mTwoTap = false;
mNativeMapView.setGestureInProgress(false);
break;

case MotionEvent.ACTION_CANCEL:
Expand Down Expand Up @@ -1780,12 +1794,30 @@ private void onConnectivityChanged(boolean isConnected) {
// Called when the map needs to be rerendered
// Called via JNI from NativeMapView
protected void onInvalidate() {
post(new Runnable() {
synchronized (mDirty) {
if (!mDirty) {
mDirty = true;
postRender();
}
}
}

private void postRender() {
Runnable mRunnable = new Runnable() {
@Override
public void run() {
mNativeMapView.invalidate();
updateCompass();
updateGpsMarker();
mNativeMapView.renderSync();
mDirty = false;
}
});
};

if (android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN) {
postOnAnimation(mRunnable);
} else {
postDelayed(mRunnable, 1000 / 60);
}
}

/**
Expand Down Expand Up @@ -1876,7 +1908,6 @@ public final boolean isMyLocationEnabled () {
public final void setMyLocationEnabled (boolean enabled) {
mIsMyLocationEnabled = enabled;
toggleGps(enabled);
updateMap(MapChange.MapChangeNullChange);
}

/**
Expand All @@ -1898,18 +1929,20 @@ private void toggleGps(boolean enableGps) {
mLocationClient.connect();
updateLocation(LocationServices.FusedLocationApi.getLastLocation());
LocationServices.FusedLocationApi.requestLocationUpdates(mLocationRequest, this);
mSensorManager.registerListener(mCompassListener, mSensorAccelerometer, SensorManager.SENSOR_DELAY_UI);
mSensorManager.registerListener(mCompassListener, mSensorMagneticField, SensorManager.SENSOR_DELAY_UI);
//mSensorManager.registerListener(mCompassListener, mSensorAccelerometer, SensorManager.SENSOR_DELAY_UI);
//mSensorManager.registerListener(mCompassListener, mSensorMagneticField, SensorManager.SENSOR_DELAY_UI);
}
} else {
if (mLocationClient.isConnected()) {
LocationServices.FusedLocationApi.removeLocationUpdates(this);
mLocationClient.disconnect();
mGpsLocation = null;
mSensorManager.unregisterListener(mCompassListener, mSensorAccelerometer);
mSensorManager.unregisterListener(mCompassListener, mSensorMagneticField);
//mSensorManager.unregisterListener(mCompassListener, mSensorAccelerometer);
//mSensorManager.unregisterListener(mCompassListener, mSensorMagneticField);
}
}

onInvalidate();
}

/**
Expand All @@ -1931,18 +1964,8 @@ public boolean isCompassEnabled () {
* @param compassEnabled true to enable the compass; false to disable the compass.
*/
public void setCompassEnabled (boolean compassEnabled) {
// Set value
this.mIsCompassEnabled = compassEnabled;

// Toggle UI
if (mIsCompassEnabled) {
mCompassView.setVisibility(View.VISIBLE);
} else {
mCompassView.setVisibility(View.GONE);
}

// Update Map
updateMap(MapChange.MapChangeNullChange);
onInvalidate();
}

public void setCompassGravity(int gravity){
Expand Down Expand Up @@ -2022,7 +2045,7 @@ public void onSensorChanged(SensorEvent event) {
}
}

updateMap(MapChange.MapChangeNullChange);
onInvalidate();
}

@Override
Expand Down Expand Up @@ -2088,7 +2111,7 @@ public void onLocationChanged(Location location) {
private void updateLocation(Location location) {
if (location != null) {
mGpsLocation = location;
updateMap(MapChange.MapChangeNullChange);
updateGpsMarker();
}
}

Expand All @@ -2102,22 +2125,17 @@ private void rotateImageView(ImageView imageView, float angle) {
}

// Updates the UI to match the current map's position
private void updateMap(MapChange change) {
// Using direct access to mIsCompassEnabled instead of isCompassEnabled() for
// small performance boost as this method is called rapidly.
if (mIsCompassEnabled) {
private void updateCompass() {
if (isCompassEnabled()) {
mCompassView.setVisibility(VISIBLE);
rotateImageView(mCompassView, (float) getDirection());
} else {
mCompassView.setVisibility(INVISIBLE);
}
}

private void updateGpsMarker() {
if (isMyLocationEnabled() && mGpsLocation != null) {
if (mGpsMarker == null) {
// Setup User Location UI
// NOTE: mIsMyLocationEnabled == false to begin with
mGpsMarker = new ImageView(getContext());
mGpsMarker.setImageResource(R.drawable.location_marker);
addView(mGpsMarker);
}

mGpsMarker.setVisibility(View.VISIBLE);
LatLng coordinate = new LatLng(mGpsLocation);
PointF screenLocation = toScreenLocation(coordinate);
Expand All @@ -2130,26 +2148,6 @@ private void updateMap(MapChange change) {
mGpsMarker.setLayoutParams(lp);
rotateImageView(mGpsMarker, 0.0f);
mGpsMarker.requestLayout();

// Update direction if tracking mode
if(mUserLocationTrackingMode == UserLocationTrackingMode.FOLLOW_BEARING && mCompassValid){
// TODO need to do proper filtering (see branch filter-compass) or else map will lock up because of all the compass events
long t = new Date().getTime();
if((t-t0)>1000){
t0 = t;
setDirection(-mCompassBearing, true);
}
}

/*
// TODO - Too much overhead on main thread. Needs to be refactored before it
// can be re-enabled
// Update map position if NOT in NONE mode
if (mUserLocationTrackingMode != UserLocationTrackingMode.NONE) {
setCenterCoordinate(new LatLng(mGpsLocation));
}
*/

/*
// Used For User Location Bearing UI
if (mGpsLocation.hasBearing() || mCompassValid) {
Expand All @@ -2169,12 +2167,27 @@ private void updateMap(MapChange change) {
mGpsMarker.setVisibility(View.INVISIBLE);
}
}
}

if (change.equals(MapChange.MapChangeRegionWillChange) || change.equals(MapChange.MapChangeRegionWillChangeAnimated)) {
deselectAnnotation();
}
// Old tracking code
// Update direction if tracking mode
/*if(mUserLocationTrackingMode == UserLocationTrackingMode.FOLLOW_BEARING && mCompassValid){
// TODO need to do proper filtering (see branch filter-compass) or else map will lock up because of all the compass events
long t = new Date().getTime();
if((t-t0)>1000){
t0 = t;
setDirection(-mCompassBearing, true);
}
}*/

}
/*
// TODO - Too much overhead on main thread. Needs to be refactored before it
// can be re-enabled
// Update map position if NOT in NONE mode
if (mUserLocationTrackingMode != UserLocationTrackingMode.NONE) {
setCenterCoordinate(new LatLng(mGpsLocation));
}
*/

private void selectAnnotation(Annotation annotation) {

Expand Down
6 changes: 3 additions & 3 deletions android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/views/NativeMapView.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ public void update() {
nativeUpdate(mNativeMapViewPtr);
}

public void invalidate() {
nativeOnInvalidate(mNativeMapViewPtr);
public void renderSync() {
nativeRenderSync(mNativeMapViewPtr);
}

public void resizeView(int width, int height) {
Expand Down Expand Up @@ -475,7 +475,7 @@ private native void nativeCreateSurface(long nativeMapViewPtr,

private native void nativeUpdate(long nativeMapViewPtr);

private native void nativeOnInvalidate(long nativeMapViewPtr);
private native void nativeRenderSync(long nativeMapViewPtr);

private native void nativeViewResize(long nativeMapViewPtr, int width, int height);

Expand Down
Loading

0 comments on commit 85ec3eb

Please sign in to comment.