Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit fafafab5 authored by Ahmad Khalil's avatar Ahmad Khalil
Browse files

Fix NullPointerException in BasicToPwleSegmentAdapter 

We're updating the BasicToPwleSegmentAdapter to check if the FrequencyProfile is empty (has no valid frequency range) before attempting to adapt the segment. Without that there is a possibility of a NullPointerException. If the FrequencyProfile is empty, then we return the segments unchanged.

Bug: 388239434
Flag: android.os.vibrator.normalized_pwle_effects
Test: atest BasicToPwleSegmentAdapterTest
Change-Id: Ic519b1e7bf2c1319bb17fa6412e2091aa2bd1353
parent a39afd3f

services/core/java/com/android/server/vibrator/BasicToPwleSegmentAdapter.java

+5 −0
Original line number Diff line number Diff line
@@ -100,6 +100,11 @@ final class BasicToPwleSegmentAdapter implements VibrationSegmentsAdapter { 
        }



        VibratorInfo.FrequencyProfile frequencyProfile = info.getFrequencyProfile();

        if (frequencyProfile.isEmpty()) {

            // The frequency profile has an invalid frequency range, so keep the segments unchanged.

            return repeatIndex;

        }



        float[] frequenciesHz = frequencyProfile.getFrequenciesHz();

        float[] accelerationsGs = frequencyProfile.getOutputAccelerationsGs();

services/tests/vibrator/src/com/android/server/vibrator/BasicToPwleSegmentAdapterTest.java

0 → 100644
+158 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.server.vibrator;



import static com.google.common.truth.Truth.assertThat;



import android.hardware.vibrator.IVibrator;

import android.os.VibratorInfo;

import android.os.vibrator.BasicPwleSegment;

import android.os.vibrator.Flags;

import android.os.vibrator.PwleSegment;

import android.os.vibrator.StepSegment;

import android.os.vibrator.VibrationEffectSegment;

import android.platform.test.annotations.DisableFlags;

import android.platform.test.annotations.EnableFlags;

import android.platform.test.flag.junit.SetFlagsRule;



import org.junit.Before;

import org.junit.Rule;

import org.junit.Test;



import java.util.ArrayList;

import java.util.Arrays;

import java.util.List;

import java.util.stream.IntStream;



public class BasicToPwleSegmentAdapterTest {



    private static final float TEST_RESONANT_FREQUENCY = 150;

    private static final float[] TEST_FREQUENCIES =

            new float[]{90f, 120f, 150f, 60f, 30f, 210f, 270f, 300f, 240f, 180f};

    private static final float[] TEST_OUTPUT_ACCELERATIONS =

            new float[]{1.2f, 1.8f, 2.4f, 0.6f, 0.1f, 2.2f, 1.0f, 0.5f, 1.9f, 3.0f};



    private static final VibratorInfo.FrequencyProfile TEST_FREQUENCY_PROFILE =

            new VibratorInfo.FrequencyProfile(TEST_RESONANT_FREQUENCY, TEST_FREQUENCIES,

                    TEST_OUTPUT_ACCELERATIONS);



    private static final VibratorInfo.FrequencyProfile EMPTY_FREQUENCY_PROFILE =

            new VibratorInfo.FrequencyProfile(TEST_RESONANT_FREQUENCY, null, null);



    private BasicToPwleSegmentAdapter mAdapter;



    @Rule

    public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();



    @Before

    public void setUp() throws Exception {

        mAdapter = new BasicToPwleSegmentAdapter();

    }



    @Test

    @DisableFlags(Flags.FLAG_NORMALIZED_PWLE_EFFECTS)

    public void testBasicPwleSegments_withFeatureFlagDisabled_returnsOriginalSegments() {

        List<VibrationEffectSegment> segments = new ArrayList<>(Arrays.asList(

                //  startIntensity, endIntensity, startSharpness, endSharpness, duration

                new BasicPwleSegment(0.2f, 0.8f, 0.2f, 0.4f, 20),

                new BasicPwleSegment(0.8f, 0.2f, 0.4f, 0.5f, 100),

                new BasicPwleSegment(0.2f, 0.65f, 0.5f, 0.5f, 50)));

        List<VibrationEffectSegment> originalSegments = new ArrayList<>(segments);



        VibratorInfo vibratorInfo = createVibratorInfo(

                TEST_FREQUENCY_PROFILE, IVibrator.CAP_COMPOSE_PWLE_EFFECTS_V2);



        assertThat(mAdapter.adaptToVibrator(vibratorInfo, segments, /*repeatIndex= */ -1))

                .isEqualTo(-1);

        assertThat(mAdapter.adaptToVibrator(vibratorInfo, segments, /*repeatIndex= */ 1))

                .isEqualTo(1);



        assertThat(segments).isEqualTo(originalSegments);

    }



    @Test

    @EnableFlags(Flags.FLAG_NORMALIZED_PWLE_EFFECTS)

    public void testBasicPwleSegments_noPwleCapability_returnsOriginalSegments() {

        List<VibrationEffectSegment> segments = new ArrayList<>(Arrays.asList(

                //  startIntensity, endIntensity, startSharpness, endSharpness, duration

                new BasicPwleSegment(0.2f, 0.8f, 0.2f, 0.4f, 20),

                new BasicPwleSegment(0.8f, 0.2f, 0.4f, 0.5f, 100),

                new BasicPwleSegment(0.2f, 0.65f, 0.5f, 0.5f, 50)));

        List<VibrationEffectSegment> originalSegments = new ArrayList<>(segments);



        VibratorInfo vibratorInfo = createVibratorInfo(TEST_FREQUENCY_PROFILE);



        assertThat(mAdapter.adaptToVibrator(vibratorInfo, segments, /*repeatIndex= */ -1))

                .isEqualTo(-1);

        assertThat(mAdapter.adaptToVibrator(vibratorInfo, segments, /*repeatIndex= */ 1))

                .isEqualTo(1);



        assertThat(segments).isEqualTo(originalSegments);

    }



    @Test

    @EnableFlags(Flags.FLAG_NORMALIZED_PWLE_EFFECTS)

    public void testBasicPwleSegments_invalidFrequencyProfile_returnsOriginalSegments() {

        List<VibrationEffectSegment> segments = new ArrayList<>(Arrays.asList(

                //  startIntensity, endIntensity, startSharpness, endSharpness, duration

                new BasicPwleSegment(0.2f, 0.8f, 0.2f, 0.4f, 20),

                new BasicPwleSegment(0.8f, 0.2f, 0.4f, 0.5f, 100),

                new BasicPwleSegment(0.2f, 0.65f, 0.5f, 0.5f, 50)));

        List<VibrationEffectSegment> originalSegments = new ArrayList<>(segments);

        VibratorInfo vibratorInfo = createVibratorInfo(

                EMPTY_FREQUENCY_PROFILE, IVibrator.CAP_COMPOSE_PWLE_EFFECTS_V2);



        assertThat(mAdapter.adaptToVibrator(vibratorInfo, segments, /*repeatIndex= */ -1))

                .isEqualTo(-1);

        assertThat(mAdapter.adaptToVibrator(vibratorInfo, segments, /*repeatIndex= */ 1))

                .isEqualTo(1);



        assertThat(segments).isEqualTo(originalSegments);

    }



    @Test

    @EnableFlags(Flags.FLAG_NORMALIZED_PWLE_EFFECTS)

    public void testBasicPwleSegments_withPwleCapability_adaptSegmentsCorrectly() {

        List<VibrationEffectSegment> segments = new ArrayList<>(Arrays.asList(

                new StepSegment(/* amplitude= */ 1, /* frequencyHz= */ 40f, /* duration= */ 100),

                //  startIntensity, endIntensity, startSharpness, endSharpness, duration

                new BasicPwleSegment(0.0f, 1.0f, 0.0f, 1.0f, 100),

                new BasicPwleSegment(0.0f, 1.0f, 0.0f, 1.0f, 100),

                new BasicPwleSegment(0.0f, 1.0f, 0.0f, 1.0f, 100)));

        List<VibrationEffectSegment> expectedSegments = Arrays.asList(

                new StepSegment(/* amplitude= */ 1, /* frequencyHz= */ 40f, /* duration= */ 100),

                //  startAmplitude, endAmplitude, startFrequencyHz, endFrequencyHz, duration

                new PwleSegment(0.0f, 1.0f, 30.0f, 300.0f, 100),

                new PwleSegment(0.0f, 1.0f, 30.0f, 300.0f, 100),

                new PwleSegment(0.0f, 1.0f, 30.0f, 300.0f, 100));

        VibratorInfo vibratorInfo = createVibratorInfo(

                TEST_FREQUENCY_PROFILE, IVibrator.CAP_COMPOSE_PWLE_EFFECTS_V2);



        assertThat(mAdapter.adaptToVibrator(vibratorInfo, segments, /*repeatIndex= */ 1))

                .isEqualTo(1);



        assertThat(segments).isEqualTo(expectedSegments);

    }



    private static VibratorInfo createVibratorInfo(VibratorInfo.FrequencyProfile frequencyProfile,

            int... capabilities) {

        return new VibratorInfo.Builder(0)

                .setCapabilities(IntStream.of(capabilities).reduce((a, b) -> a | b).orElse(0))

                .setFrequencyProfile(frequencyProfile)

                .build();

    }

}