added picture in picture support

Change-Id: I83fdb69e0aedc9f352d7b13daabdbb0f324c81d5
Signed-off-by: AbdAlMoniem AlHifnawy <hifnawy_moniem@hotmail.com>

Author: abdalmoniem

.github/workflows/build_debug_variant.yml

@@ -20,9 +20,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Check base64
-        run: base64 --version
-
       - name: Create local.properties
         run: |
           echo ${{ secrets.SIGNING_KEY }} | base64 -d > release_keystore.jks

.github/workflows/build_release_variant.yml

@@ -16,9 +16,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Check base64
-        run: base64 --version
-
       - name: Create local.properties
         run: |
           echo ${{ secrets.SIGNING_KEY }} | base64 -d > release_keystore.jks

.github/workflows/publish_release_by_tag.yml

@@ -1,6 +1,6 @@
 #file: noinspection Annotator
 name: Publish Release By Tag
-run-name: ${{ github.workflow }} Tag ${{ inputs.releaseTag }}
+run-name: ${{ github.workflow }} ${{ inputs.releaseTag }} ${{ github.event.repository.updated_at}}
 on:
   workflow_dispatch:
     inputs:
@@ -9,6 +9,7 @@ on:
         required: true
         type: choice
         options:
+          - v2.0.0
           - v1.8.0
           - v1.7.5
           - v1.7.2
@@ -39,31 +40,19 @@ on:
           - v1.1.1
           - v1.1
           - v1.0
-      logLevel:
-        description: 'Log level'
-        required: true
-        default: 'info'
-        type: choice
-        options:
-          - info
-          - warning
-          - debug
-permissions: {}
+
+permissions: { }
+
 jobs:
   publish-release-by-tag:
     name: Publish Release By Tag
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Tag ${{ inputs.releaseTag }}
         uses: actions/checkout@v4
-        env:
-          LEVEL: ${{ inputs.logLevel }}
         with:
           ref: refs/tags/${{ inputs.releaseTag }}
-      - name: Check base64
-        env:
-          LEVEL: ${{ inputs.logLevel }}
-        run: base64 --version
+
       - name: Create local.properties
         run: |
           echo ${{ secrets.SIGNING_KEY }} | base64 -d > release_keystore.jks
@@ -76,55 +65,51 @@ jobs:
           echo "keyPassword=${{ secrets.KEY_PASSWORD }}" >> local.properties
           echo "keyAlias=release_key" >> local.properties
           echo "storeFile=$keystoreFile" >> local.properties
+
       - name: Setup Java
         uses: actions/setup-java@v4
-        env:
-          LEVEL: ${{ inputs.logLevel }}
         with:
           distribution: 'adopt'
           java-version: 21
+
       - name: Validate Gradle Wrapper
         uses: gradle/wrapper-validation-action@v2.1.3
-        env:
-          LEVEL: ${{ inputs.logLevel }}
+
       - name: Build APKs
-        env:
-          LEVEL: ${{ inputs.logLevel }}
         run: |
           ls
           bash gradlew app:assembleRelease
+
       - name: Get Release APK Name
-        env:
-          LEVEL: ${{ inputs.logLevel }}
         run: |
           releaseApk=$(find app/build/outputs/apk/release/*.apk)
           echo $releaseApk
           echo ARTIFACT_NAME=$(basename $releaseApk) >> $GITHUB_ENV
           echo ARTIFACT_PATH=$releaseApk >> $GITHUB_ENV
+
       - name: Create Artifact ${{ env.ARTIFACT_NAME }}
         uses: actions/upload-artifact@v4
-        env:
-          LEVEL: ${{ inputs.logLevel }}
         with:
           name: ${{ env.ARTIFACT_NAME }}
           path: ${{ env.ARTIFACT_PATH }}
           if-no-files-found: error
+
       - name: Get Commit Message
-        env:
-          LEVEL: ${{ inputs.logLevel }}
         run: |
-          echo "COMMIT_MESSAGE=$(git show -s --format=%B)"
+          gitTopLevel="$(git rev-parse --show-toplevel)"
+          versionCodeFilter="\(versionCode\s\+=\s\+\)\([[:digit:]]\+\)"
+          versionCode=$(git show "$tag:app/build.gradle.kts" | grep versionCode | sed -e "s/$versionCodeFilter/\2/" | xargs)
+          
+          cat "$gitTopLevel/fastlane/metadata/android/en-US/changelogs/$versionCode.txt"
+          
           {
               echo 'COMMIT_MESSAGE<<EOF'
-              git show -s --format=%B | sed -e 's/Change-Id:\s*\w\+//' | sed -e 's/Signed-off-by:\s*.*//' | sed ':a;N;$!ba;s/\n*$//'
+              cat "$gitTopLevel/fastlane/metadata/android/en-US/changelogs/$versionCode.txt"
               echo EOF
           } >> $GITHUB_ENV
-      - name: Publish Release ${{ inputs.releaseTag }}
-        # noinspection SpellCheckingInspection
 
+      - name: Publish Release ${{ github.ref_name }}
         uses: svenstaro/upload-release-action@v2
-        env:
-          LEVEL: ${{ inputs.logLevel }}
         with:
           file: ${{ env.ARTIFACT_PATH }}
           tag: refs/tags/${{ inputs.releaseTag }}
@@ -134,4 +119,4 @@ jobs:
           make_latest: true
           body: ${{ env.COMMIT_MESSAGE }}
           release_name: ${{ inputs.releaseTag }}
-          repo_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
+          repo_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}

.github/workflows/publish_release_on_tag.yml

@@ -1,6 +1,6 @@
 #file: noinspection Annotator
 name: Publish Release On Tag
-run-name: ${{ github.workflow }} ${{ github.ref_name }}
+run-name: ${{ github.workflow }} ${{ github.ref_name }} ${{ github.event.repository.updated_at}}
 
 on:
   push:
@@ -19,9 +19,6 @@ jobs:
       - name: Checkout ${{ github.ref }}
         uses: actions/checkout@v4
 
-      - name: Check base64
-        run: base64 --version
-
       - name: Create local.properties
         run: |
           echo ${{ secrets.SIGNING_KEY }} | base64 -d > release_keystore.jks
@@ -63,15 +60,19 @@ jobs:
 
       - name: Get Commit Message
         run: |
-          echo "COMMIT_MESSAGE=$(git show -s --format=%B)"
+          gitTopLevel="$(git rev-parse --show-toplevel)"
+          versionCodeFilter="\(versionCode\s\+=\s\+\)\([[:digit:]]\+\)"
+          versionCode=$(git show "$tag:app/build.gradle.kts" | grep versionCode | sed -e "s/$versionCodeFilter/\2/" | xargs)
+          
+          cat "$gitTopLevel/fastlane/metadata/android/en-US/changelogs/$versionCode.txt"
+          
           {
               echo 'COMMIT_MESSAGE<<EOF'
-              git show -s --format=%B | sed -e 's/Change-Id:\s*\w\+//' | sed -e 's/Signed-off-by:\s*.*//' | sed ':a;N;$!ba;s/\n*$//'
+              cat "$gitTopLevel/fastlane/metadata/android/en-US/changelogs/$versionCode.txt"
               echo EOF
           } >> $GITHUB_ENV
 
       - name: Publish Release ${{ github.ref_name }}
-        # noinspection SpellCheckingInspection
         uses: svenstaro/upload-release-action@v2
         with:
           file: ${{ env.ARTIFACT_PATH }}

app/build.gradle.kts

@@ -115,8 +115,8 @@ android {
         minSdk = 24
         compileSdk = 35
         targetSdk = 35
-        versionCode = 30
-        versionName = "1.8.0"
+        versionCode = 31
+        versionName = "2.0.0"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
 

app/src/main/AndroidManifest.xml

@@ -24,8 +24,11 @@
 
         <activity
             android:name=".view.MainActivity"
+            android:configChanges="screenSize|smallestScreenSize|screenLayout|orientation"
             android:exported="true"
-            android:launchMode="singleTask">
+            android:launchMode="singleTask"
+            android:supportsPictureInPicture="true"
+            android:resizeableActivity="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
                 <action android:name="android.service.quicksettings.action.QS_TILE_PREFERENCES" />

app/src/main/java/com/hifnawy/caffeinate/controller/ServiceStatus.kt

@@ -34,7 +34,7 @@ sealed class ServiceStatus {
      *
      * @author AbdAlMoniem AlHifnawy
      */
-    data class Running(private var startTimeout: Duration) : ServiceStatus() {
+    class Running(startTimeout: Duration) : ServiceStatus() {
 
         /**
          * Interface for observing changes to the remaining timeout duration while the service is running.
@@ -61,6 +61,16 @@ sealed class ServiceStatus {
             fun onRemainingUpdated()
         }
 
+        /**
+         * The timeout duration in seconds.
+         *
+         * This property is used to determine when the service should stop.
+         *
+         * @return [Duration] the timeout duration in seconds.
+         */
+        var startTimeout: Duration = startTimeout
+            private set
+
         /**
          * Indicates whether the service is running indefinitely.
          *

app/src/main/java/com/hifnawy/caffeinate/controller/SharedPrefsManager.kt

@@ -11,6 +11,7 @@ import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.CONT
 import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.ENABLE_DIMMING
 import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.ENABLE_MATERIAL_YOU
 import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.ENABLE_OVERLAY
+import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.ENABLE_PICTURE_IN_PICTURE
 import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.ENABLE_WHILE_LOCKED
 import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.IS_SERVICE_RUNNING
 import com.hifnawy.caffeinate.controller.SharedPrefsManager.SharedPrefsKeys.LAST_REMAINING_TIMEOUT
@@ -80,11 +81,6 @@ class SharedPrefsManager(private val caffeinateApplication: CaffeinateApplicatio
          */
         CONTRAST_LEVEL,
 
-        /**
-         * A [Boolean] value indicating whether the screen should be dimmed while the service is running.
-         */
-        ENABLE_DIMMING,
-
         /**
          * A [Boolean] value indicating whether Material You design elements should be enabled.
          */
@@ -95,6 +91,16 @@ class SharedPrefsManager(private val caffeinateApplication: CaffeinateApplicatio
          */
         ENABLE_OVERLAY,
 
+        /**
+         * A [Boolean] value indicating whether the application should be enabled in picture-in-picture mode.
+         */
+        ENABLE_PICTURE_IN_PICTURE,
+
+        /**
+         * A [Boolean] value indicating whether the screen should be dimmed while the service is running.
+         */
+        ENABLE_DIMMING,
+
         /**
          * A [Boolean] value indicating whether the service should be enabled while the screen is locked.
          */
@@ -222,24 +228,13 @@ class SharedPrefsManager(private val caffeinateApplication: CaffeinateApplicatio
     /**
      * List of available timeouts that can be selected by the user.
      *
-     * This list is used to populate the [DialogChooseTimeoutsBinding][com.hifnawy.caffeinate.databinding.DialogChooseTimeoutsBinding] and provide the
-     * user with a variety of timeouts to choose from.
-     *
-     * The items in this list are used to generate the list items in the
-     * [DialogChooseTimeoutsBinding][com.hifnawy.caffeinate.databinding.DialogChooseTimeoutsBinding] and are used to populate the
-     * [CheckBoxItem] list.
-     *
      * @return [List] A list of [Duration] objects representing the available timeouts.
      */
     // val timeouts by lazy { listOf(30.seconds, 5.minutes, 10.minutes, 15.minutes, 30.minutes, 60.minutes, 120.minutes, 240.minutes, 480.minutes, Duration.INFINITE) }
     val timeouts by lazy { listOf(30.seconds, 5.minutes, 10.minutes, 15.minutes, 30.minutes, 60.minutes, Duration.INFINITE) }
 
     /**
-     * Checks if all necessary permissions are granted.
-     *
-     * This property is used to keep track of whether all necessary permissions have been granted. It is used to determine whether the main activity
-     * should display the [DialogChooseTimeoutsBinding][com.hifnawy.caffeinate.databinding.DialogChooseTimeoutsBinding] or not, and to enable or
-     * disable the [DialogChooseTimeoutsBinding][com.hifnawy.caffeinate.databinding.DialogChooseTimeoutsBinding] based on the state of this property.
+     * Retrieves or sets whether all necessary permissions are granted.
      *
      * @return [Boolean] `true` if all necessary permissions are granted, `false` otherwise.
      */
@@ -305,6 +300,18 @@ class SharedPrefsManager(private val caffeinateApplication: CaffeinateApplicatio
             notifySharedPrefsObservers { observer -> observer.onIsOverlayEnabledUpdated(value) }
         }
 
+    /**
+     * Retrieves or sets whether picture-in-picture mode is enabled.
+     *
+     * This property is used to get or update the preference of whether picture-in-picture mode should be enabled.
+     * It allows the application to persist the user's preference across sessions.
+     *
+     * @return [Boolean] `true` if picture-in-picture mode is enabled, `false` otherwise.
+     */
+    var isPictureInPictureEnabled: Boolean
+        get() = sharedPreferences.getBoolean(ENABLE_PICTURE_IN_PICTURE.name, false)
+        set(value) = sharedPreferences.edit().putBoolean(ENABLE_PICTURE_IN_PICTURE.name, value).apply()
+
     /**
      * Retrieves or sets whether the screen should be dimmed while it is being kept awake.
      *
@@ -458,6 +465,13 @@ interface SharedPrefsObserver : Observer {
      */
     fun onIsOverlayEnabledUpdated(isOverlayEnabled: Boolean) = Unit
 
+    /**
+     * Called when the "Picture in Picture Enabled" preference changes.
+     *
+     * @param isPictureInPictureEnabled [Boolean] `true` if the "Picture in Picture" feature is enabled, `false` otherwise.
+     */
+    fun onIsPictureInPictureEnabledUpdated(isPictureInPictureEnabled: Boolean) = Unit
+
     /**
      * Called when the "Dimming Enabled" preference changes.
      *

app/src/main/java/com/hifnawy/caffeinate/utils/ViewExtensionFunctions.kt

@@ -1,5 +1,6 @@
 package com.hifnawy.caffeinate.utils
 
+import android.graphics.Rect
 import android.view.View
 
 /**
@@ -25,4 +26,24 @@ object ViewExtensionFunctions {
         set(value) {
             visibility = if (value) View.VISIBLE else View.GONE
         }
+
+    /**
+     * Sets a listener to be called when the size of the view changes.
+     *
+     * This extension function adds an OnLayoutChangeListener to the view which executes the provided
+     * callback whenever the view's size changes. The callback provides the new and old dimensions of
+     * the view, allowing developers to respond to size changes.
+     *
+     * @param callback A function to be invoked when the view's size changes. It receives the view itself,
+     * the new width and height, and the old width and height as parameters.
+     */
+    inline fun View.onSizeChange(crossinline callback: (view: View, newWidth: Int, newHeight: Int, oldWidth: Int, oldHeight: Int) -> Unit) =
+            addOnLayoutChangeListener { view, left, top, right, bottom, oldLeft, oldTop, oldRight, oldBottom ->
+                val rect = Rect(left, top, right, bottom)
+                val oldRect = Rect(oldLeft, oldTop, oldRight, oldBottom)
+
+                if (rect.width() == oldRect.width() && rect.height() == oldRect.height()) return@addOnLayoutChangeListener
+
+                callback(view, rect.width(), rect.height(), oldRect.width(), oldRect.height())
+            }
 }