SwarmUI generation provider (#217)

* Swarm UI working prototype implementation

* Swarm UI models implementation

* Swarm UI LoRAs implementation

* Swarm UI Embeddings implementation

* Fixed GenerationBottomToolbar

* Update strings / docs

* Add translations

* Unit test coverage 1

* Update empty UI states

* Fix Gallery detail original img2img base64 output format

* Finalize implementation

Author: ShiftHackZ

README.md

@@ -16,6 +16,7 @@ Stable Diffusion AI is an easy-to-use app that lets you quickly generate images
 
 - Can use server environment powered by [AI Horde](https://stablehorde.net/) (a crowdsourced distributed cluster of Stable Diffusion workers)
 - Can use server environment powered by [Stable-Diffusion-WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui) (AUTOMATIC1111)
+- Can use server environment powered by [SwarmUI](https://github.com/mcmonkeyprojects/SwarmUI)
 - Can use server envitonment powered by [Hugging Face Inference API](https://huggingface.co/docs/api-inference/quicktour).
 - Can use server environment powered by [OpenAI](https://platform.openai.com/docs/api-reference/images) (DALL-E-2, DALL-E-3).
 - Can use server environment powered by [Stability AI](https://platform.stability.ai/).
@@ -70,31 +71,39 @@ You can have it running either on your own hardware with modern GPU from Nvidia
 
 If for some reason you have no ability to run your server instance, you can toggle the **Demo mode** switch on server setup page: it will allow you to test the app and get familiar with it, but it will return some mock images instead of AI-generated ones.
 
-### Option 2: Use AI Horde
+### Option 2: Use your own SwarmUI instance
+
+This requires you to have the SwarmUI that is running in server mode.
+
+You can have it running either on your own hardware with modern GPU from Nvidia or AMD, or running it using Google Colab.
+
+Please refer to the [SwarmUI documentation](https://github.com/mcmonkeyprojects/SwarmUI?tab=readme-ov-file#swarmui) for installation instructions.
+
+### Option 3: Use AI Horde
 
 [AI Horde](https://stablehorde.net/) is a crowdsourced distributed cluster of Image generation workers and text generation workers. 
 
 AI Horde requires to use API KEY, this mobile app alows to use either default API KEY (which is "0000000000"), or type your own. You can sign up and get your own AI Horde API KEY [here](https://stablehorde.net/register).
 
-### Option 3: Hugging Face Inference
+### Option 4: Hugging Face Inference
 
 [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index) allows to test and evaluate, over 150,000 publicly accessible machine learning models, or your own private models, via simple HTTP requests, with fast inference hosted on Hugging Face shared infrastructure. This service is free, but is rate-limited.
 
 Hugging Face Inference requires to use API KEY, which can be created in [Hugging Face account settings](https://huggingface.co/settings/tokens).
 
-### Option 4: OpenAI
+### Option 5: OpenAI
 
 OpenAI provides a service for text to image generation using [DALLE-2](https://openai.com/dall-e-2) or [DALLE-3](https://openai.com/dall-e-3) models. This service is paid. 
 
 OpenAI requires to use API KEY, which can be created in [OpenAI API Key settings](https://platform.openai.com/api-keys).
 
-### Option 5: StabilityAI
+### Option 6: StabilityAI
 
 [StabilityAI](https://platform.stability.ai/) is the image generation service provided by DreamStudio.
 
 StabilityAI requires to use API KEY, which can be created in [API Keys page](https://platform.stability.ai/account/keys).
 
-### Option 6: Local Diffusion (Beta)
+### Option 7: Local Diffusion (Beta)
 
 Only **txt2img** mode is supported.
 

app/build.gradle

@@ -34,6 +34,7 @@ android {
         buildConfigField "String", "DONATE_URL", "\"https://www.buymeacoffee.com/shifthackz\""
         buildConfigField "String", "GITHUB_SOURCE_URL", "\"https://github.com/ShiftHackZ/Stable-Diffusion-Android\""
         buildConfigField "String", "SETUP_INSTRUCTIONS_URL", "\"https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki\""
+        buildConfigField "String", "SWARM_UI_INFO_URL", "\"https://github.com/mcmonkeyprojects/SwarmUI/tree/master/docs\""
 
         resourceConfigurations = ["en", "ru", "uk", "tr", "zh"]
     }

app/src/main/java/com/shifthackz/aisdv1/app/di/ProvidersModule.kt

@@ -107,6 +107,7 @@ val providersModule = module {
             override val donateUrl: String = BuildConfig.DONATE_URL
             override val gitHubSourceUrl: String = BuildConfig.GITHUB_SOURCE_URL
             override val setupInstructionsUrl: String = BuildConfig.SETUP_INSTRUCTIONS_URL
+            override val swarmUiInfoUrl: String = BuildConfig.SWARM_UI_INFO_URL
             override val demoModeUrl: String = BuildConfig.DEMO_MODE_API_URL
         }
     }

core/common/src/main/java/com/shifthackz/aisdv1/core/common/links/LinksProvider.kt

@@ -10,5 +10,6 @@ interface LinksProvider {
     val donateUrl: String
     val gitHubSourceUrl: String
     val setupInstructionsUrl: String
+    val swarmUiInfoUrl: String
     val demoModeUrl: String
 }

core/common/src/main/java/com/shifthackz/aisdv1/core/common/model/Hexagonal.kt

@@ -0,0 +1,15 @@
+package com.shifthackz.aisdv1.core.common.model
+
+import java.io.Serializable
+
+data class Hexagonal<out A, out B, out C, out D, out E, out F>(
+    val first: A,
+    val second: B,
+    val third: C,
+    val fourth: D,
+    val fifth: E,
+    val sixth: F,
+) : Serializable {
+
+    override fun toString(): String = "($first, $second, $third, $fourth, $fifth, $sixth)"
+}

core/common/src/main/java/com/shifthackz/aisdv1/core/common/model/Quadruple.kt

@@ -2,7 +2,6 @@ package com.shifthackz.aisdv1.core.common.model
 
 import java.io.Serializable
 
-
 data class Quadruple<out A, out B, out C, out D>(
     val first: A,
     val second: B,

core/imageprocessing/src/main/java/com/shifthackz/aisdv1/core/imageprocessing/Base64EncodingConverter.kt

@@ -0,0 +1,36 @@
+package com.shifthackz.aisdv1.core.imageprocessing
+
+import com.shifthackz.aisdv1.core.common.log.errorLog
+import com.shifthackz.aisdv1.core.imageprocessing.Base64EncodingConverter.Input
+import com.shifthackz.aisdv1.core.imageprocessing.Base64EncodingConverter.Output
+import com.shifthackz.aisdv1.core.imageprocessing.contract.RxImageProcessor
+import com.shifthackz.aisdv1.core.imageprocessing.utils.base64DefaultToNoWrap
+import io.reactivex.rxjava3.core.Scheduler
+import io.reactivex.rxjava3.core.Single
+
+private typealias Base64EncodingProcessor = RxImageProcessor<Input, Output>
+
+class Base64EncodingConverter(
+    private val processingScheduler: Scheduler,
+) : Base64EncodingProcessor {
+
+    override fun invoke(input: Input): Single<Output> = Single
+        .create { emitter ->
+            convert(input).fold(
+                onSuccess = emitter::onSuccess,
+                onFailure = emitter::onError,
+            )
+        }
+        .onErrorReturn { t ->
+            errorLog(t)
+            Output(input.base64)
+        }
+        .subscribeOn(processingScheduler)
+
+    private fun convert(input: Input): Result<Output> = runCatching {
+        Output(base64DefaultToNoWrap(input.base64))
+    }
+
+    data class Input(val base64: String)
+    data class Output(val base64: String)
+}

core/imageprocessing/src/main/java/com/shifthackz/aisdv1/core/imageprocessing/di/ImageProcessingModule.kt

@@ -2,6 +2,7 @@ package com.shifthackz.aisdv1.core.imageprocessing.di
 
 import android.graphics.BitmapFactory
 import com.shifthackz.aisdv1.core.common.schedulers.SchedulersProvider
+import com.shifthackz.aisdv1.core.imageprocessing.Base64EncodingConverter
 import com.shifthackz.aisdv1.core.imageprocessing.Base64ToBitmapConverter
 import com.shifthackz.aisdv1.core.imageprocessing.BitmapToBase64Converter
 import com.shifthackz.aisdv1.core.imageprocessing.R
@@ -20,4 +21,8 @@ val imageProcessingModule = module {
     factory {
         BitmapToBase64Converter(get<SchedulersProvider>().computation)
     }
+
+    factory {
+        Base64EncodingConverter(get<SchedulersProvider>().computation)
+    }
 }

core/imageprocessing/src/main/java/com/shifthackz/aisdv1/core/imageprocessing/utils/Base64ImageUtils.kt

@@ -15,3 +15,8 @@ fun bitmapToBase64(bitmap: Bitmap): String {
     bitmap.compress(Bitmap.CompressFormat.PNG, 100, outputStream)
     return Base64.encodeToString(outputStream.toByteArray(), Base64.DEFAULT)
 }
+
+fun base64DefaultToNoWrap(base64Default: String): String {
+    val byteArray = Base64.decode(base64Default, Base64.DEFAULT)
+    return Base64.encodeToString(byteArray, Base64.NO_WRAP)
+}

data/src/main/java/com/shifthackz/aisdv1/data/di/LocalDataSourceModule.kt

@@ -3,25 +3,27 @@ package com.shifthackz.aisdv1.data.di
 import com.shifthackz.aisdv1.data.gateway.DatabaseClearGatewayImpl
 import com.shifthackz.aisdv1.data.gateway.mediastore.MediaStoreGatewayFactory
 import com.shifthackz.aisdv1.data.local.DownloadableModelLocalDataSource
+import com.shifthackz.aisdv1.data.local.EmbeddingsLocalDataSource
 import com.shifthackz.aisdv1.data.local.GenerationResultLocalDataSource
 import com.shifthackz.aisdv1.data.local.HuggingFaceModelsLocalDataSource
+import com.shifthackz.aisdv1.data.local.LorasLocalDataSource
 import com.shifthackz.aisdv1.data.local.ServerConfigurationLocalDataSource
 import com.shifthackz.aisdv1.data.local.StabilityAiCreditsLocalDataSource
-import com.shifthackz.aisdv1.data.local.StableDiffusionEmbeddingsLocalDataSource
 import com.shifthackz.aisdv1.data.local.StableDiffusionHyperNetworksLocalDataSource
-import com.shifthackz.aisdv1.data.local.StableDiffusionLorasLocalDataSource
 import com.shifthackz.aisdv1.data.local.StableDiffusionModelsLocalDataSource
 import com.shifthackz.aisdv1.data.local.StableDiffusionSamplersLocalDataSource
+import com.shifthackz.aisdv1.data.local.SwarmUiModelsLocalDataSource
 import com.shifthackz.aisdv1.domain.datasource.DownloadableModelDataSource
+import com.shifthackz.aisdv1.domain.datasource.EmbeddingsDataSource
 import com.shifthackz.aisdv1.domain.datasource.GenerationResultDataSource
 import com.shifthackz.aisdv1.domain.datasource.HuggingFaceModelsDataSource
+import com.shifthackz.aisdv1.domain.datasource.LorasDataSource
 import com.shifthackz.aisdv1.domain.datasource.ServerConfigurationDataSource
 import com.shifthackz.aisdv1.domain.datasource.StabilityAiCreditsDataSource
-import com.shifthackz.aisdv1.domain.datasource.StableDiffusionEmbeddingsDataSource
 import com.shifthackz.aisdv1.domain.datasource.StableDiffusionHyperNetworksDataSource
-import com.shifthackz.aisdv1.domain.datasource.StableDiffusionLorasDataSource
 import com.shifthackz.aisdv1.domain.datasource.StableDiffusionModelsDataSource
 import com.shifthackz.aisdv1.domain.datasource.StableDiffusionSamplersDataSource
+import com.shifthackz.aisdv1.domain.datasource.SwarmUiModelsDataSource
 import com.shifthackz.aisdv1.domain.gateway.DatabaseClearGateway
 import org.koin.android.ext.koin.androidContext
 import org.koin.core.module.dsl.factoryOf
@@ -35,9 +37,10 @@ val localDataSourceModule = module {
     single<StabilityAiCreditsDataSource.Local> { StabilityAiCreditsLocalDataSource() }
     factoryOf(::StableDiffusionModelsLocalDataSource) bind StableDiffusionModelsDataSource.Local::class
     factoryOf(::StableDiffusionSamplersLocalDataSource) bind StableDiffusionSamplersDataSource.Local::class
-    factoryOf(::StableDiffusionLorasLocalDataSource) bind StableDiffusionLorasDataSource.Local::class
+    factoryOf(::LorasLocalDataSource) bind LorasDataSource.Local::class
     factoryOf(::StableDiffusionHyperNetworksLocalDataSource) bind StableDiffusionHyperNetworksDataSource.Local::class
-    factoryOf(::StableDiffusionEmbeddingsLocalDataSource) bind StableDiffusionEmbeddingsDataSource.Local::class
+    factoryOf(::EmbeddingsLocalDataSource) bind EmbeddingsDataSource.Local::class
+    factoryOf(::SwarmUiModelsLocalDataSource) bind SwarmUiModelsDataSource.Local::class
     factoryOf(::ServerConfigurationLocalDataSource) bind ServerConfigurationDataSource.Local::class
     factoryOf(::GenerationResultLocalDataSource) bind GenerationResultDataSource.Local::class
     factoryOf(::DownloadableModelLocalDataSource) bind DownloadableModelDataSource.Local::class