Merge branch 'davidmotson.imagen_editing' into davidmotson.imagen_editing_docs

Author: David Motsonashvili

firebase-ai/api.txt

@@ -65,6 +65,7 @@ package com.google.firebase.ai {
   }
 
   @com.google.firebase.ai.type.PublicPreviewAPI public final class ImagenModel {
+    method public suspend Object? editImage(String prompt, com.google.firebase.ai.type.ImagenEditingConfig config, kotlin.coroutines.Continuation<? super com.google.firebase.ai.type.ImagenGenerationResponse<com.google.firebase.ai.type.ImagenInlineImage>>);
     method public suspend Object? generateImages(String prompt, kotlin.coroutines.Continuation<? super com.google.firebase.ai.type.ImagenGenerationResponse<com.google.firebase.ai.type.ImagenInlineImage>>);
   }
 
@@ -104,6 +105,7 @@ package com.google.firebase.ai.java {
   }
 
   @com.google.firebase.ai.type.PublicPreviewAPI public abstract class ImagenModelFutures {
+    method public abstract com.google.common.util.concurrent.ListenableFuture<com.google.firebase.ai.type.ImagenGenerationResponse<com.google.firebase.ai.type.ImagenInlineImage>> editImage(String prompt, com.google.firebase.ai.type.ImagenEditingConfig config);
     method public static final com.google.firebase.ai.java.ImagenModelFutures from(com.google.firebase.ai.ImagenModel model);
     method public abstract com.google.common.util.concurrent.ListenableFuture<com.google.firebase.ai.type.ImagenGenerationResponse<com.google.firebase.ai.type.ImagenInlineImage>> generateImages(String prompt);
     method public abstract com.google.firebase.ai.ImagenModel getImageModel();
@@ -484,6 +486,47 @@ package com.google.firebase.ai.type {
   public static final class ImagenAspectRatio.Companion {
   }
 
+  public final class ImagenEditMode {
+    field public static final com.google.firebase.ai.type.ImagenEditMode.Companion Companion;
+  }
+
+  public static final class ImagenEditMode.Companion {
+    method public com.google.firebase.ai.type.ImagenEditMode getINPAINT_INSERTION();
+    method public com.google.firebase.ai.type.ImagenEditMode getINPAINT_REMOVAL();
+    method public com.google.firebase.ai.type.ImagenEditMode getOUTPAINT();
+    property public final com.google.firebase.ai.type.ImagenEditMode INPAINT_INSERTION;
+    property public final com.google.firebase.ai.type.ImagenEditMode INPAINT_REMOVAL;
+    property public final com.google.firebase.ai.type.ImagenEditMode OUTPAINT;
+  }
+
+  @com.google.firebase.ai.type.PublicPreviewAPI public final class ImagenEditingConfig {
+    ctor public ImagenEditingConfig(com.google.firebase.ai.type.ImagenInlineImage image, com.google.firebase.ai.type.ImagenEditMode editMode, com.google.firebase.ai.type.ImagenInlineImage? mask = null, Double? maskDilation = null, Integer? editSteps = null);
+    field public static final com.google.firebase.ai.type.ImagenEditingConfig.Companion Companion;
+  }
+
+  public static final class ImagenEditingConfig.Builder {
+    ctor public ImagenEditingConfig.Builder();
+    method public com.google.firebase.ai.type.ImagenEditingConfig build();
+    method public com.google.firebase.ai.type.ImagenEditingConfig.Builder setEditMode(com.google.firebase.ai.type.ImagenEditMode editMode);
+    method public com.google.firebase.ai.type.ImagenEditingConfig.Builder setEditSteps(int editSteps);
+    method public com.google.firebase.ai.type.ImagenEditingConfig.Builder setImage(com.google.firebase.ai.type.ImagenInlineImage image);
+    method public com.google.firebase.ai.type.ImagenEditingConfig.Builder setMask(com.google.firebase.ai.type.ImagenInlineImage mask);
+    method public com.google.firebase.ai.type.ImagenEditingConfig.Builder setMaskDilation(double maskDilation);
+    field public com.google.firebase.ai.type.ImagenEditMode? editMode;
+    field public Integer? editSteps;
+    field public com.google.firebase.ai.type.ImagenInlineImage? image;
+    field public com.google.firebase.ai.type.ImagenInlineImage? mask;
+    field public Double? maskDilation;
+  }
+
+  public static final class ImagenEditingConfig.Companion {
+    method public com.google.firebase.ai.type.ImagenEditingConfig.Builder builder();
+  }
+
+  public final class ImagenEditingConfigKt {
+    method @com.google.firebase.ai.type.PublicPreviewAPI public static com.google.firebase.ai.type.ImagenEditingConfig imagenEditingConfig(kotlin.jvm.functions.Function1<? super com.google.firebase.ai.type.ImagenEditingConfig.Builder,kotlin.Unit> init);
+  }
+
   @com.google.firebase.ai.type.PublicPreviewAPI public final class ImagenGenerationConfig {
     ctor public ImagenGenerationConfig(String? negativePrompt = null, Integer? numberOfImages = 1, com.google.firebase.ai.type.ImagenAspectRatio? aspectRatio = null, com.google.firebase.ai.type.ImagenImageFormat? imageFormat = null, Boolean? addWatermark = null);
     method public Boolean? getAddWatermark();
@@ -552,6 +595,10 @@ package com.google.firebase.ai.type {
     property public final String mimeType;
   }
 
+  public final class ImagenInlineImageKt {
+    method @com.google.firebase.ai.type.PublicPreviewAPI public static com.google.firebase.ai.type.ImagenInlineImage toImagenInlineImage(android.graphics.Bitmap);
+  }
+
   @com.google.firebase.ai.type.PublicPreviewAPI public final class ImagenPersonFilterLevel {
     field public static final com.google.firebase.ai.type.ImagenPersonFilterLevel ALLOW_ADULT;
     field public static final com.google.firebase.ai.type.ImagenPersonFilterLevel ALLOW_ALL;

firebase-ai/src/main/kotlin/com/google/firebase/ai/ImagenModel.kt

@@ -76,7 +76,7 @@ internal constructor(
   public suspend fun generateImages(prompt: String): ImagenGenerationResponse<ImagenInlineImage> =
     try {
       controller
-        .generateImage(constructGenerationRequest(prompt, null, generationConfig))
+        .generateImage(constructGenerateImageRequest(prompt, generationConfig))
         .validate()
         .toPublicInline()
     } catch (e: Throwable) {
@@ -95,31 +95,27 @@ internal constructor(
     config: ImagenEditingConfig
   ): ImagenGenerationResponse<ImagenInlineImage> =
     try {
-      controller
-        .generateImage(constructEditRequest(prompt, null, config))
-        .validate()
-        .toPublicInline()
+      controller.generateImage(constructEditRequest(prompt, config)).validate().toPublicInline()
     } catch (e: Throwable) {
       throw FirebaseAIException.from(e)
     }
 
-  private fun constructGenerationRequest(
+  private fun constructGenerateImageRequest(
     prompt: String,
-    gcsUri: String? = null,
     generationConfig: ImagenGenerationConfig? = null,
   ): GenerateImageRequest {
     return GenerateImageRequest(
       listOf(GenerateImageRequest.ImagenPrompt(prompt)),
       GenerateImageRequest.ImagenParameters(
         sampleCount = generationConfig?.numberOfImages ?: 1,
         includeRaiReason = true,
-        addWatermark = this.generationConfig?.addWatermark,
+        addWatermark = generationConfig?.addWatermark,
         personGeneration = safetySettings?.personFilterLevel?.internalVal,
         negativePrompt = generationConfig?.negativePrompt,
         safetySetting = safetySettings?.safetyFilterLevel?.internalVal,
-        storageUri = gcsUri,
+        storageUri = null,
         aspectRatio = generationConfig?.aspectRatio?.internalVal,
-        imageOutputOptions = this.generationConfig?.imageFormat?.toInternal(),
+        imageOutputOptions = generationConfig?.imageFormat?.toInternal(),
         editMode = null,
         editConfig = null
       ),
@@ -128,7 +124,6 @@ internal constructor(
 
   private fun constructEditRequest(
     prompt: String,
-    gcsUri: String? = null,
     editConfig: ImagenEditingConfig,
   ): GenerateImageRequest {
     return GenerateImageRequest(
@@ -165,13 +160,13 @@ internal constructor(
       GenerateImageRequest.ImagenParameters(
         sampleCount = generationConfig?.numberOfImages ?: 1,
         includeRaiReason = true,
-        addWatermark = this.generationConfig?.addWatermark,
+        addWatermark = generationConfig?.addWatermark,
         personGeneration = safetySettings?.personFilterLevel?.internalVal,
         negativePrompt = generationConfig?.negativePrompt,
         safetySetting = safetySettings?.safetyFilterLevel?.internalVal,
-        storageUri = gcsUri,
+        storageUri = null,
         aspectRatio = generationConfig?.aspectRatio?.internalVal,
-        imageOutputOptions = this.generationConfig?.imageFormat?.toInternal(),
+        imageOutputOptions = generationConfig?.imageFormat?.toInternal(),
         editMode = editConfig.editMode.value,
         editConfig = editConfig.toInternal()
       ),

firebase-ai/src/main/kotlin/com/google/firebase/ai/common/Request.kt

@@ -93,7 +93,7 @@ internal data class GenerateImageRequest(
   @Serializable
   internal data class ImagenParameters(
     val sampleCount: Int,
-    val includeRaiReason: Boolean?,
+    val includeRaiReason: Boolean,
     val storageUri: String?,
     val negativePrompt: String?,
     val aspectRatio: String?,

firebase-ai/src/main/kotlin/com/google/firebase/ai/java/ImagenModelFutures.kt

@@ -19,6 +19,7 @@ package com.google.firebase.ai.java
 import androidx.concurrent.futures.SuspendToFutureAdapter
 import com.google.common.util.concurrent.ListenableFuture
 import com.google.firebase.ai.ImagenModel
+import com.google.firebase.ai.type.ImagenEditingConfig
 import com.google.firebase.ai.type.ImagenGenerationResponse
 import com.google.firebase.ai.type.ImagenInlineImage
 import com.google.firebase.ai.type.PublicPreviewAPI
@@ -39,6 +40,11 @@ public abstract class ImagenModelFutures internal constructor() {
     prompt: String,
   ): ListenableFuture<ImagenGenerationResponse<ImagenInlineImage>>
 
+  public abstract fun editImage(
+    prompt: String,
+    config: ImagenEditingConfig
+  ): ListenableFuture<ImagenGenerationResponse<ImagenInlineImage>>
+
   /** Returns the [ImagenModel] object wrapped by this object. */
   public abstract fun getImageModel(): ImagenModel
 
@@ -48,6 +54,12 @@ public abstract class ImagenModelFutures internal constructor() {
     ): ListenableFuture<ImagenGenerationResponse<ImagenInlineImage>> =
       SuspendToFutureAdapter.launchFuture { model.generateImages(prompt) }
 
+    override fun editImage(
+      prompt: String,
+      config: ImagenEditingConfig
+    ): ListenableFuture<ImagenGenerationResponse<ImagenInlineImage>> =
+      SuspendToFutureAdapter.launchFuture { model.editImage(prompt, config) }
+
     override fun getImageModel(): ImagenModel = model
   }
 

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenEditingConfig.kt

@@ -28,11 +28,11 @@ import kotlinx.serialization.Serializable
  */
 @PublicPreviewAPI
 public class ImagenEditingConfig(
-  public val image: ImagenInlineImage,
-  public val editMode: ImagenEditMode,
-  public val mask: ImagenInlineImage? = null,
-  public val maskDilation: Double? = null,
-  public val editSteps: Int? = null,
+  internal val image: ImagenInlineImage,
+  internal val editMode: ImagenEditMode,
+  internal val mask: ImagenInlineImage? = null,
+  internal val maskDilation: Double? = null,
+  internal val editSteps: Int? = null,
 ) {
   public companion object {
     public fun builder(): Builder = Builder()

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/ImagenInlineImage.kt

@@ -49,7 +49,7 @@ internal constructor(public val data: ByteArray, public val mimeType: String) {
 }
 
 @PublicPreviewAPI
-public fun Bitmap.toImagenImage(): ImagenInlineImage {
+public fun Bitmap.toImagenInlineImage(): ImagenInlineImage {
   val byteArrayOutputStream = ByteArrayOutputStream()
   this.compress(Bitmap.CompressFormat.PNG, 100, byteArrayOutputStream)
   val byteArray = byteArrayOutputStream.toByteArray()