Merge stories creation save frame refactor

app/src/main/java/com/automattic/portkey/compose/frame/FrameSaveManager.kt

@@ -0,0 +1,205 @@
+package com.automattic.portkey.compose.frame
+
+import android.content.Context
+import android.graphics.BitmapFactory
+import android.graphics.Color
+import android.net.Uri
+import android.view.ViewGroup.LayoutParams
+import android.widget.RelativeLayout
+import com.automattic.photoeditor.PhotoEditor
+import com.automattic.photoeditor.PhotoEditor.OnSaveWithCancelListener
+import com.automattic.photoeditor.views.PhotoEditorView
+import com.automattic.photoeditor.views.ViewType.STICKER_ANIMATED
+import com.automattic.portkey.compose.story.StoryFrameItem
+import com.automattic.portkey.compose.story.StoryFrameItem.BackgroundSource.FileBackgroundSource
+import com.automattic.portkey.compose.story.StoryFrameItem.BackgroundSource.UriBackgroundSource
+import com.automattic.portkey.compose.story.StoryFrameItemType.IMAGE
+import com.automattic.portkey.compose.story.StoryFrameItemType.VIDEO
+import com.automattic.portkey.util.cloneViewSpecs
+import com.automattic.portkey.util.removeViewFromParent
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.async
+import kotlinx.coroutines.awaitAll
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.withContext
+import kotlinx.coroutines.yield
+import java.io.File
+import kotlin.coroutines.CoroutineContext
+
+class FrameSaveManager(private val photoEditor: PhotoEditor) : CoroutineScope {
+    private val job = Job()
+    override val coroutineContext: CoroutineContext
+        get() = Dispatchers.Default + job
+
+    // TODO: not sure whether we really want to cancel a Story frame saving operation, but for now I'll  let this
+    // one in to be a good citizen with Activity / CoroutineScope
+    fun onCancel() {
+        job.cancel()
+    }
+
+    suspend fun saveStory(
+        context: Context,
+        frames: List<StoryFrameItem>
+    ): List<File?> {
+        // first, launch all frame save processes async
+        return frames.mapIndexed { index, frame ->
+            withContext(coroutineContext) {
+                async {
+                    yield()
+                    saveLoopFrame(context, frame, index)
+                }
+            }
+        }.awaitAll()
+    }
+
+    private suspend fun saveLoopFrame(
+        context: Context,
+        frame: StoryFrameItem,
+        sequenceId: Int
+    ): File? {
+        var frameFile: File? = null
+        when (frame.frameItemType) {
+            VIDEO -> {
+                frameFile = saveVideoFrame(frame, sequenceId)
+            }
+            IMAGE -> {
+                // check whether there are any GIF stickers - if there are, we need to produce a video instead
+                if (frame.addedViews.containsAnyAddedViewsOfType(STICKER_ANIMATED)) {
+                    // TODO make saveVideoWithStaticBackground return File
+                    // saveVideoWithStaticBackground()
+                } else {
+                    // create ghost PhotoEditorView to be used for saving off-screen
+                    val ghostPhotoEditorView = createGhostPhotoEditor(context, photoEditor.composedCanvas)
+                    frameFile = saveImageFrame(frame, ghostPhotoEditorView, sequenceId)
+                }
+            }
+        }
+        return frameFile
+    }
+
+    private suspend fun saveImageFrame(
+        frame: StoryFrameItem,
+        ghostPhotoEditorView: PhotoEditorView,
+        sequenceId: Int
+    ): File {
+        // prepare the ghostview with its background image and the AddedViews on top of it
+        preparePhotoEditorViewForSnapshot(frame, ghostPhotoEditorView)
+        val file = withContext(Dispatchers.IO) {
+            return@withContext photoEditor.saveImageFromPhotoEditorViewAsLoopFrameFile(sequenceId, ghostPhotoEditorView)
+        }
+
+        withContext(Dispatchers.Main) {
+            // don't forget to remove these views from ghost offscreen view before exiting
+            for (oneView in frame.addedViews) {
+                removeViewFromParent(oneView.view)
+            }
+        }
+        return file
+    }
+
+    private suspend fun saveVideoFrame(
+        frame: StoryFrameItem,
+        sequenceId: Int
+    ): File? {
+        var file: File? = null
+
+        withContext(Dispatchers.IO) {
+            var listenerDone = false
+            val saveListener = object : PhotoEditor.OnSaveWithCancelListener {
+                override fun onCancel(noAddedViews: Boolean) {
+                    // TODO: error handling
+                    listenerDone = true
+                }
+
+                override fun onSuccess(filePath: String) {
+                    // all good here, continue success path
+                    file = File(filePath)
+                    listenerDone = true
+                }
+
+                override fun onFailure(exception: Exception) {
+                    // TODO: error handling
+                    listenerDone = true
+                }
+            }
+
+            if (saveVideoAsLoopFrameFile(frame, sequenceId, saveListener)) {
+                // don't return until we get a signal in the listener
+                while (!listenerDone) {
+                    delay(100)
+                }
+            }
+        }
+
+        return file
+    }
+
+    private fun saveVideoAsLoopFrameFile(
+        frame: StoryFrameItem,
+        sequenceId: Int,
+        onSaveListener: OnSaveWithCancelListener
+    ): Boolean {
+        var callMade = false
+        val uri: Uri? = (frame.source as? UriBackgroundSource)?.contentUri
+            ?: Uri.parse((frame.source as FileBackgroundSource).file?.absolutePath)
+        // we only need the width and height of a model canvas, not creating a canvas clone in the case of videos
+        // as these are all processed in the background
+        uri?.let {
+            photoEditor.saveVideoAsLoopFrameFile(
+                sequenceId,
+                it,
+                photoEditor.composedCanvas.width,
+                photoEditor.composedCanvas.height,
+                frame.addedViews,
+                onSaveListener
+            )
+            callMade = true
+        }
+        return callMade
+    }
+
+    private suspend fun preparePhotoEditorViewForSnapshot(
+        frame: StoryFrameItem,
+        ghostPhotoEditorView: PhotoEditorView
+    ) {
+        // prepare background
+        if (frame.source is FileBackgroundSource) {
+            frame.source.file?.let {
+                ghostPhotoEditorView.source.setImageBitmap(BitmapFactory.decodeFile(it.absolutePath))
+            }
+        }
+        if (frame.source is UriBackgroundSource) {
+            frame.source.contentUri?.let {
+                ghostPhotoEditorView.source.setImageURI(it)
+            }
+        }
+
+        // removeViewFromParent for views that were added in the UI thread need to also run on the main thread
+        // otherwise we'd get a android.view.ViewRootImpl$CalledFromWrongThreadException:
+        // Only the original thread that created a view hierarchy can touch its views.
+        withContext(Dispatchers.Main) {
+            // now call addViewToParent the addedViews remembered by this frame
+            for (oneView in frame.addedViews) {
+                removeViewFromParent(oneView.view)
+                ghostPhotoEditorView.addView(oneView.view, getViewLayoutParams())
+            }
+        }
+    }
+
+    private fun getViewLayoutParams(): LayoutParams {
+        val params = RelativeLayout.LayoutParams(
+            LayoutParams.WRAP_CONTENT, LayoutParams.WRAP_CONTENT
+        )
+        params.addRule(RelativeLayout.CENTER_IN_PARENT, RelativeLayout.TRUE)
+        return params
+    }
+
+    private fun createGhostPhotoEditor(context: Context, originalPhotoEditorView: PhotoEditorView): PhotoEditorView {
+        val ghostPhotoView = PhotoEditorView(context)
+        cloneViewSpecs(context, originalPhotoEditorView, ghostPhotoView)
+        ghostPhotoView.setBackgroundColor(Color.BLACK)
+        return ghostPhotoView
+    }
+}

app/src/main/java/com/automattic/portkey/compose/story/StoryFrameItem.kt

@@ -10,34 +10,8 @@ data class StoryFrameItem(
     val frameItemType: StoryFrameItemType = IMAGE,
     var addedViews: AddedViewList = AddedViewList()
 ) {
-    class BackgroundSource {
-        var file: File? = null
-        var contentUri: Uri? = null
-
-        constructor (file: File) {
-            this.file = file
-        }
-        constructor(contentUri: Uri) {
-            this.contentUri = contentUri
-        }
-
-        fun isUri(): Boolean {
-            return contentUri != null
-        }
-
-        fun isFile(): Boolean {
-            return file != null
-        }
-
-        fun isDefault(): Boolean {
-            return isFile() && file == DEFAULT_SOURCE
-        }
-
-        companion object {
-            private val DEFAULT_SOURCE = File("")
-            fun getDefault(): BackgroundSource {
-                return BackgroundSource(DEFAULT_SOURCE)
-            }
-        }
+    sealed class BackgroundSource {
+        data class UriBackgroundSource(var contentUri: Uri? = null) : BackgroundSource()
+        data class FileBackgroundSource(var file: File? = null) : BackgroundSource()
     }
 }

app/src/main/java/com/automattic/portkey/compose/story/StoryViewModel.kt

@@ -3,6 +3,8 @@ package com.automattic.portkey.compose.story
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
+import com.automattic.portkey.compose.story.StoryFrameItem.BackgroundSource.FileBackgroundSource
+import com.automattic.portkey.compose.story.StoryFrameItem.BackgroundSource.UriBackgroundSource
 import com.automattic.portkey.compose.story.StoryViewModel.StoryFrameListItemUiState.StoryFrameListItemUiStateFrame
 import com.automattic.portkey.compose.story.StoryViewModel.StoryFrameListItemUiState.StoryFrameListItemUiStatePlusIcon
 import com.automattic.portkey.util.SingleLiveEvent
@@ -86,6 +88,10 @@ class StoryViewModel(private val repository: StoryRepository, val storyIndex: In
         return repository.getCurrentStorySize()
     }
 
+    fun getImmutableCurrentStoryFrames(): List<StoryFrameItem> {
+        return repository.getImmutableCurrentStoryFrames()
+    }
+
     fun anyOfCurrentStoryFramesHasViews(): Boolean {
         val frames = repository.getImmutableCurrentStoryFrames()
         for (frame in frames) {
@@ -171,7 +177,11 @@ class StoryViewModel(private val repository: StoryRepository, val storyIndex: In
         storyItems.forEachIndexed { index, model ->
             val isSelected = (getSelectedFrameIndex() == index)
             val filePath =
-                if (model.source.isUri()) model.source.contentUri.toString() else model.source.file.toString()
+                if ((model.source is UriBackgroundSource)) {
+                    model.source.contentUri.toString()
+                } else {
+                    (model.source as FileBackgroundSource).file.toString()
+                }
             val oneFrameUiState = StoryFrameListItemUiStateFrame(
                 selected = isSelected, filePath = filePath
             )

app/src/main/java/com/automattic/portkey/util/ViewUtils.kt

@@ -0,0 +1,26 @@
+package com.automattic.portkey.util
+
+import android.content.Context
+import android.view.View
+import android.view.ViewGroup
+import androidx.core.view.children
+
+fun removeViewFromParent(view: View) {
+    view.parent?.let {
+        it as ViewGroup
+        if (it.children.contains(view)) {
+            it.removeView(view)
+        }
+    }
+}
+
+fun cloneViewSpecs(context: Context, originalView: View, targetView: View) {
+    val originalWidth = originalView.getWidth()
+    val originalHeight = originalView.getHeight()
+
+    val measuredWidth = View.MeasureSpec.makeMeasureSpec(originalWidth, View.MeasureSpec.EXACTLY)
+    val measuredHeight = View.MeasureSpec.makeMeasureSpec(originalHeight, View.MeasureSpec.EXACTLY)
+
+    targetView.measure(measuredWidth, measuredHeight)
+    targetView.layout(0, 0, targetView.getMeasuredWidth(), targetView.getMeasuredHeight())
+}

app/src/main/res/layout/content_composer.xml

@@ -352,6 +352,15 @@
         android:visibility="gone"
         android:layout_width="match_parent"
         android:layout_height="match_parent"
-        />
+        android:background="@color/black_transp">
+        <TextView
+            android:id="@+id/operation_text"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:textSize="28sp"
+            android:textColor="@color/white"
+            android:layout_gravity="center"
+            android:text="Saving..."/>
+    </FrameLayout>
 
 </androidx.constraintlayout.widget.ConstraintLayout>

app/src/main/res/values/strings.xml

@@ -33,6 +33,7 @@
     <string name="label_remove">Drag here to remove</string>
     <string name="label_done">Done</string>
     <string name="label_control_next">Next</string>
+    <string name="label_saving">Saving...</string>
 
     <string name="menu_delete_frame">Delete frame</string>
     <string name="dialog_discard_frame_message">Are you sure you want to delete this frame from your Story?</string>