Merge pull request #4 from android/adaptive-jetstream

Publishing AdaptiveJetStream

Author: chikoski

AdaptiveJetStream/.gitignore

@@ -0,0 +1,10 @@
+*.iml
+.gradle
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+/.idea/
+local.properties
+.kotlin

AdaptiveJetStream/LICENSES.md

@@ -0,0 +1,24 @@
+# Open source licenses and copyright notices
+
+## [Coil](https://coil-kt.github.io/coil/#license)
+
+Copyright 2022 Coil Contributors
+
+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
+
+https://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.
+
+## [Big Buck Bunny Video](https://peach.blender.org/about/)
+
+This work is licensed under
+a [Creative Commons Attribution 2.5](https://creativecommons.org/licenses/by/2.5/legalcode) license.
+
+(c) copyright 2008, Blender Foundation / www.bigbuckbunny.org

AdaptiveJetStream/README.md

@@ -0,0 +1,48 @@
+# **Adaptive Apps Samples: JetStream**
+
+Jetstream is a sample media streaming application designed to adapt to various form factors using a single binary. It leverages Compose Material3  for cross-device compatibility, enabling [adaptive experiences](https://developer.android.com/adaptive-apps) across different form factors.
+
+* Mobile device  
+* Tablet  
+* Foldable device  
+* Chromebook  
+* TV  
+* Automotive  
+* XR device
+
+![Home screens on different form factors](Screenshots.png)
+
+This directory contains a version of the JetStream TV sample app that utilizes [Compose Material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) components, with some exceptions like the [featured carousel](https://developer.android.com/design/ui/tv/guides/components/featured-carousel). It builds upon the original JetStream sample to offer experiences tailored to different device form factors. The original JetStream app for TV can be found at [https://github.com/android/tv-samples/](https://github.com/android/tv-samples/).
+
+## Requirements
+
+* You need  Android Studio to try the sample app.   
+* If you are trying JetStream on XR emulator,  refer to [this document](https://developer.android.com/develop/xr/jetpack-xr-sdk/setup) for the details.  
+* You can clone this repository and build the sample app in AdaptiveJetStream directory.  Refer to [this document](https://developer.android.com/jetpack/compose/setup#sample) for the steps.
+
+## Performance
+
+The `benchmarks` module contains sample tests written using the [Macrobenchmark](https://developer.android.com/studio/profile/macrobenchmark) library. It also contains the test to generate the baseline profile for JetStream app.
+
+### Baseline profiles
+
+The baseline profile for this app is generated as `jetstream/src/release/generated/baselineProfiles/baseline-prof.txt`, which contains rules that enable AOT compilation of the critical user path taken during app launch. Refer to this [document](https://developer.android.com/studio/profile/baselineprofiles) to learn more about baseline profiles
+
+## License
+
+```  
+Copyright 2025 Google LLC
+
+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
+
+    https://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.  
+```
+

AdaptiveJetStream/Screenshots.png

@@ -0,0 +1,71 @@
+# Baseline Profiles
+
+[Details on developer.android.com](https://developer.android.com/studio/profile/baselineprofiles)
+
+
+## Generating baseline profiles
+
+To generate the baseline profile for Jetstream app, run "Generate Baseline Profile" from "**Run**".
+
+> Note: The baseline profile needs to be re-generated for release builds that touch code which changes app startup.
+
+To learn more on generating baseline profiles, follow this [Codelab](http://goo.gle/baseline-profiles).
+
+
+## Applying baseline profiles
+
+Baseline profiles are automatically applied when an app is installed from the Play Store and also when running benchmark test cases.
+
+
+To apply the baseline profile when running the app from Android Studio, follow these steps:
+
+
+**Step-1**: Install and launch the app manually or follow this command:
+
+```
+adb shell am start -n com.google.jetstream/com.google.jetstream.MainActivity
+```
+
+> Note: When testing for performance, it is always best to install the release build of the app.
+
+
+**Step-2**: Compile the app with baseline profile using the following command: 
+
+```
+adb shell cmd package compile -f -m speed-profile com.google.jetstream
+```
+
+
+**Step-3**: Determine the status of profile by running the following:
+
+```
+adb shell dumpsys package dexopt | grep -A 1 com.google.jetstream
+```
+
+If the status is `status=speed-profile`, it means that baseline profile rules have been applied to optimize the app. Therefore, you can skip directly to **Step-5**.
+
+If the status is different, follow the next step.
+
+
+**Step-4**: Execute the background optimizations by running the following command: 
+
+```
+adb shell cmd package bg-dexopt-job
+```
+
+It executes a background task that typically takes about ~40 seconds to complete. Once complete, please follow **Step-3** again to verify the status.
+
+
+**Step-5**: Force close the app and launch it again manually or follow these commands:
+
+```
+// Force close the app
+adb shell am force-stop com.google.jetstream
+
+// Launch the app
+adb shell am start -n com.google.jetstream/com.google.jetstream.MainActivity
+```
+
+Now, you can observe the improvement in the app's startup and overall performance as perceived by the end user.
+
+

AdaptiveJetStream/baseline-profiles.md

@@ -0,0 +1 @@
+build

AdaptiveJetStream/benchmark/.gitignore

@@ -0,0 +1,82 @@
+import com.android.build.api.dsl.ManagedVirtualDevice
+
+/*
+ * Copyright 2023 Google LLC
+ *
+ * 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
+ *
+ * https://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.
+ */
+
+plugins {
+    alias(libs.plugins.android.test)
+    alias(libs.plugins.kotlin.android)
+    alias(libs.plugins.kotlin.serialization)
+    alias(libs.plugins.compose.compiler)
+    alias(libs.plugins.androidx.baselineprofile)
+}
+
+kotlin {
+    jvmToolchain(17)
+}
+
+android {
+    namespace = "com.google.jetstream.benchmark"
+    compileSdk = 35
+
+    defaultConfig {
+        minSdk = 28
+        targetSdk = 35
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        testInstrumentationRunnerArguments["androidx.benchmark.suppressErrors"] = "EMULATOR"
+    }
+
+    buildFeatures {
+        compose = true
+        buildConfig = true
+    }
+
+    testOptions.managedDevices.devices {
+        create<ManagedVirtualDevice>("tvApi34") {
+            device = "Television (1080p)"
+            apiLevel = 34
+            systemImageSource = "aosp"
+        }
+    }
+
+    targetProjectPath = ":jetstream"
+}
+
+baselineProfile {
+    managedDevices += "tvApi34"
+    useConnectedDevices = false
+}
+
+
+dependencies {
+    implementation(libs.androidx.junit)
+    implementation(libs.androidx.uiautomator)
+
+    // Support for TV activities with LEANBACK_LAUNCHER intent was added in 1.2.0-alpha03 release
+    // Use 1.2.0-alpha03 or above versions for benchmarking TV apps
+    implementation(libs.androidx.benchmark.macro.junit4)
+    implementation(libs.androidx.rules)
+
+    implementation(platform(libs.androidx.compose.bom))
+    implementation(libs.androidx.compose.runtime)
+}
+
+androidComponents {
+    beforeVariants(selector().withBuildType("benchmark").all()) {
+        it.enable = true
+    }
+}