Merge pull request #412 from HaishinKit/feature/textureid

shogo4405 · web-flow · commit 7e07a7e784ba · 2026-02-02T19:29:06.000+09:00
Added a string ID for managing ScreenObject.
diff --git a/app/src/main/java/com/haishinkit/app/CameraViewModel.kt b/app/src/main/java/com/haishinkit/app/CameraViewModel.kt
@@ -8,7 +8,6 @@ import android.graphics.Bitmap
 import android.graphics.BitmapFactory
 import android.graphics.Rect
 import android.provider.MediaStore
-import android.util.Log
 import androidx.core.net.toUri
 import androidx.lifecycle.AndroidViewModel
 import androidx.lifecycle.DefaultLifecycleObserver
diff --git a/haishinkit/src/main/java/com/haishinkit/gles/PixelTransform.kt b/haishinkit/src/main/java/com/haishinkit/gles/PixelTransform.kt
@@ -160,7 +160,7 @@ internal class PixelTransform(
                     video.videoSize = Size(screen.frame.width(), screen.frame.height())
                 }
                 if (video.shouldInvalidateLayout) {
-                    video.id = screen.id
+                    video.textureId = screen.textureId
                     video.layout(renderer)
                 }
                 program?.use()
diff --git a/haishinkit/src/main/java/com/haishinkit/gles/Program.kt b/haishinkit/src/main/java/com/haishinkit/gles/Program.kt
@@ -89,7 +89,7 @@ internal class Program(
         GLES20.glUniformMatrix4fv(mvpMatrixHandle, 1, false, screenObject.matrix, 0)
         Utils.checkGlError("glUniformMatrix4fv")
 
-        GLES20.glBindTexture(screenObject.target, screenObject.id)
+        GLES20.glBindTexture(screenObject.target, screenObject.textureId)
         Utils.checkGlError("glBindTexture")
 
         GLES20.glDrawArrays(GLES20.GL_TRIANGLE_STRIP, 0, 4)
diff --git a/haishinkit/src/main/java/com/haishinkit/gles/screen/Renderer.kt b/haishinkit/src/main/java/com/haishinkit/gles/screen/Renderer.kt
@@ -45,7 +45,7 @@ internal class Renderer(
 
             is ImageScreenObject -> {
                 val bitmap = screenObject.bitmap ?: return
-                GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, screenObject.id)
+                GLES20.glBindTexture(GLES20.GL_TEXTURE_2D, screenObject.textureId)
                 Utils.checkGlError("glBindTexture")
                 GLES20.glPixelStorei(GLES20.GL_UNPACK_ALIGNMENT, 1)
                 Utils.checkGlError("glPixelStorei")
diff --git a/haishinkit/src/main/java/com/haishinkit/gles/screen/Screen.kt b/haishinkit/src/main/java/com/haishinkit/gles/screen/Screen.kt
@@ -27,7 +27,7 @@ internal class Screen(
 
     private var textureIds = intArrayOf(0)
 
-    override var id: Int
+    override var textureId: Int
         get() = framebuffer.textureId
         set(value) {
         }
@@ -56,27 +56,27 @@ internal class Screen(
             is VideoScreenObject -> {
                 val track = screenObject.track
                 videoTextureRegistry.getTextureIdByTrack(track)?.let { id ->
-                    screenObject.id = id
+                    screenObject.textureId = id
                 }
             }
 
             else -> {
                 GLES20.glGenTextures(1, textureIds, 0)
-                screenObject.id = textureIds[0]
+                screenObject.textureId = textureIds[0]
             }
         }
     }
 
     override fun unbind(screenObject: ScreenObject) {
         when (screenObject) {
             is VideoScreenObject -> {
-                screenObject.id = 0
+                screenObject.textureId = 0
             }
 
             else -> {
-                textureIds[0] = screenObject.id
+                textureIds[0] = screenObject.textureId
                 GLES20.glDeleteTextures(1, textureIds, 0)
-                screenObject.id = 0
+                screenObject.textureId = 0
             }
         }
     }
@@ -90,9 +90,9 @@ internal class Screen(
         } else {
             videoTextureRegistry.register(track, video)
             videoTextureRegistry.getTextureIdByTrack(track)?.let { id ->
-                getScreenObjects(VideoScreenObject::class.java).forEach {
+                findByClass(VideoScreenObject::class.java).forEach {
                     if (it.track == track) {
-                        it.id = id
+                        it.textureId = id
                         it.videoSize = video.videoSize
                         it.imageOrientation = video.imageOrientation
                     }
diff --git a/haishinkit/src/main/java/com/haishinkit/gles/screen/ThreadScreen.kt b/haishinkit/src/main/java/com/haishinkit/gles/screen/ThreadScreen.kt
@@ -21,8 +21,8 @@ internal class ThreadScreen(
             return screen.graphicsContext
         }
 
-    override var id: Int
-        get() = screen.id
+    override var textureId: Int
+        get() = screen.textureId
         set(value) {
         }
 
@@ -138,9 +138,15 @@ internal class ThreadScreen(
         }
     }
 
-    override fun <T : ScreenObject> getScreenObjects(clazz: Class<T>): List<T> {
+    override fun <T : ScreenObject> findByClass(clazz: Class<T>): List<T> {
         return handler.run {
-            screen.getScreenObjects(clazz)
+            screen.findByClass(clazz)
+        }
+    }
+
+    override fun findById(targetId: String): ScreenObject? {
+        return handler.run {
+            screen.findById(targetId)
         }
     }
 
diff --git a/haishinkit/src/main/java/com/haishinkit/media/MediaMixer.kt b/haishinkit/src/main/java/com/haishinkit/media/MediaMixer.kt
@@ -89,7 +89,7 @@ class MediaMixer(
                 val windowManager =
                     context.getSystemService(Context.WINDOW_SERVICE) as WindowManager
                 windowManager.defaultDisplay?.orientation?.let { orientation ->
-                    screen.getScreenObjects(VideoScreenObject::class.java).forEach {
+                    screen.findByClass(VideoScreenObject::class.java).forEach {
                         it.deviceOrientation = orientation
                     }
                 }
@@ -145,7 +145,7 @@ class MediaMixer(
         track: Int,
         videoEffect: VideoEffect,
     ) {
-        screen.getScreenObjects(VideoScreenObject::class.java).forEach {
+        screen.findByClass(VideoScreenObject::class.java).forEach {
             if (it.track == track) {
                 it.videoEffect = videoEffect
             }
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/ImageScreenObject.kt b/haishinkit/src/main/java/com/haishinkit/screen/ImageScreenObject.kt
@@ -8,7 +8,9 @@ import java.io.ByteArrayOutputStream
 /**
  * An object that manages offscreen rendering an image source.
  */
-open class ImageScreenObject : ScreenObject() {
+open class ImageScreenObject(
+    id: String? = null,
+) : ScreenObject(id) {
     private interface Keys {
         companion object {
             const val BITMAP: String = "bitmap"
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/MediaOutputScreenObject.kt b/haishinkit/src/main/java/com/haishinkit/screen/MediaOutputScreenObject.kt
@@ -29,7 +29,8 @@ import java.lang.ref.WeakReference
 @Suppress("UNUSED")
 class MediaOutputScreenObject(
     context: Context,
-) : VideoScreenObject(),
+    id: String? = null,
+) : VideoScreenObject(id),
     MediaOutput {
     override var type: String = "media"
 
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/NullScreenObject.kt b/haishinkit/src/main/java/com/haishinkit/screen/NullScreenObject.kt
@@ -1,6 +1,8 @@
 package com.haishinkit.screen
 
-internal class NullScreenObject : ScreenObject() {
+internal class NullScreenObject(
+    id: String? = null,
+) : ScreenObject(id) {
     override val type: String = TYPE
 
     override var elements: Map<String, String>
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/ScreenObject.kt b/haishinkit/src/main/java/com/haishinkit/screen/ScreenObject.kt
@@ -5,17 +5,42 @@ import android.opengl.GLES20
 import android.util.Log
 import com.haishinkit.graphics.effect.DefaultVideoEffect
 import com.haishinkit.graphics.effect.VideoEffect
+import java.util.UUID
 import kotlin.math.max
 
 /**
  * The ScreenObject class is the abstract class for all objects that are rendered on the screen.
  */
 @Suppress("MemberVisibilityCanBePrivate")
 abstract class ScreenObject(
+    id: String?,
     val target: Int = GLES20.GL_TEXTURE_2D,
 ) {
+    /**
+     * Logical type of this screen object.
+     *
+     * This value is typically used for serialization, debugging,
+     * or distinguishing between different kinds of screen objects.
+     */
     abstract val type: String
-    open var id: Int = -1
+
+    /**
+     * Unique identifier of this screen object.
+     *
+     * The identifier must be unique within the owning scene or document
+     * and is commonly used for lookup and state management.
+     */
+    val id: String = id ?: UUID.randomUUID().toString()
+
+    /**
+     * OpenGL ES texture ID associated with this screen object.
+     *
+     * A value of `-1` indicates that no texture has been assigned yet.
+     *
+     * The setter is restricted to internal use to prevent external
+     * modification of the OpenGL resource state.
+     */
+    open var textureId: Int = -1
         internal set
 
     /**
@@ -190,6 +215,13 @@ abstract class ScreenObject(
         }
     }
 
+    open fun findById(id: String): ScreenObject? {
+        if (this.id == id) {
+            return this
+        }
+        return null
+    }
+
     companion object {
         private val TAG = ScreenObject::class.java.simpleName
         const val HORIZONTAL_ALIGNMENT_LEFT = 0
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/ScreenObjectContainer.kt b/haishinkit/src/main/java/com/haishinkit/screen/ScreenObjectContainer.kt
@@ -4,7 +4,9 @@ package com.haishinkit.screen
  *  A ScreenObjectContainer represents a collection of screen objects.
  */
 @Suppress("UNUSED")
-open class ScreenObjectContainer : ScreenObject() {
+open class ScreenObjectContainer(
+    id: String? = null,
+) : ScreenObject(id) {
     override val type: String = TYPE
 
     /**
@@ -86,6 +88,19 @@ open class ScreenObjectContainer : ScreenObject() {
         invalidateLayout()
     }
 
+    override fun findById(id: String): ScreenObject? {
+        if (this.id == id) {
+            return this
+        }
+        for (child in children) {
+            val result = child.findById(id)
+            if (result != null) {
+                return result
+            }
+        }
+        return null
+    }
+
     open fun transition(screenObjectContainer: ScreenObjectContainer) {
         for (i in children.size - 1 downTo 0) {
             children[i].parent = null
@@ -138,7 +153,7 @@ open class ScreenObjectContainer : ScreenObject() {
         return children
     }
 
-    internal open fun <T : ScreenObject> getScreenObjects(clazz: Class<T>): List<T> {
+    internal open fun <T : ScreenObject> findByClass(clazz: Class<T>): List<T> {
         val objects =
             children
                 .mapNotNull {
@@ -152,7 +167,7 @@ open class ScreenObjectContainer : ScreenObject() {
         return objects +
             children
                 .filterIsInstance<ScreenObjectContainer>()
-                .flatMap { it.getScreenObjects(clazz) }
+                .flatMap { it.findByClass(clazz) }
     }
 
     companion object {
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/ScreenObjectFactory.kt b/haishinkit/src/main/java/com/haishinkit/screen/ScreenObjectFactory.kt
@@ -13,35 +13,35 @@ class ScreenObjectFactory {
         creators[type] = creator
     }
 
-    fun create(data: ScreenObjectSnapshot): ScreenObject {
-        return when (data.type) {
+    fun create(snapshot: ScreenObjectSnapshot): ScreenObject {
+        return when (snapshot.type) {
             Screen.TYPE,
             ScreenObjectContainer.TYPE,
             -> {
-                ScreenObjectContainer().apply {
-                    for (child in data.children) {
+                ScreenObjectContainer(snapshot.id).apply {
+                    for (child in snapshot.children) {
                         addChild(create(child))
                     }
                 }
             }
 
-            ImageScreenObject.TYPE -> ImageScreenObject()
-            VideoScreenObject.TYPE -> VideoScreenObject()
-            TextScreenObject.TYPE -> TextScreenObject()
+            ImageScreenObject.TYPE -> ImageScreenObject(snapshot.id)
+            VideoScreenObject.TYPE -> VideoScreenObject(snapshot.id)
+            TextScreenObject.TYPE -> TextScreenObject(snapshot.id)
             else -> {
-                creators[data.type]?.invoke(data) ?: NullScreenObject()
+                creators[snapshot.type]?.invoke(snapshot) ?: NullScreenObject(snapshot.id)
             }
         }.apply {
-            layoutMargins.set(data.layoutMargin)
+            layoutMargins.set(snapshot.layoutMargin)
             frame.set(
-                data.frame.x,
-                data.frame.y,
-                data.frame.x + data.frame.width,
-                data.frame.y + data.frame.height,
+                snapshot.frame.x,
+                snapshot.frame.y,
+                snapshot.frame.x + snapshot.frame.width,
+                snapshot.frame.y + snapshot.frame.height,
             )
-            verticalAlignment = data.verticalAlignment
-            horizontalAlignment = data.horizontalAlignment
-            elements = data.elements
+            verticalAlignment = snapshot.verticalAlignment
+            horizontalAlignment = snapshot.horizontalAlignment
+            elements = snapshot.elements
         }
     }
 }
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/TextScreenObject.kt b/haishinkit/src/main/java/com/haishinkit/screen/TextScreenObject.kt
@@ -13,7 +13,9 @@ import kotlin.math.max
  * An object that manages offscreen rendering a text source.
  */
 @Suppress("MemberVisibilityCanBePrivate")
-class TextScreenObject : ImageScreenObject() {
+class TextScreenObject(
+    id: String? = null,
+) : ImageScreenObject(id) {
     private interface Keys {
         companion object {
             const val VALUE = "value"
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/VideoScreenObject.kt b/haishinkit/src/main/java/com/haishinkit/screen/VideoScreenObject.kt
@@ -16,8 +16,9 @@ import com.haishinkit.util.swap
  */
 @Suppress("MemberVisibilityCanBePrivate")
 open class VideoScreenObject(
+    id: String? = null,
     target: Int = GLES11Ext.GL_TEXTURE_EXTERNAL_OES,
-) : ScreenObject(target) {
+) : ScreenObject(id, target) {
     private interface Keys {
         companion object {
             const val TRACK = "track"
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/scene/ScreenObjectSnapshot.kt b/haishinkit/src/main/java/com/haishinkit/screen/scene/ScreenObjectSnapshot.kt
@@ -39,6 +39,7 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class ScreenObjectSnapshot(
     val type: String,
+    val id: String,
     val frame: Rect,
     val layoutMargin: EdgeInsets,
     val horizontalAlignment: Int,
diff --git a/haishinkit/src/main/java/com/haishinkit/screen/scene/ScreenObjectSnapshotFactory.kt b/haishinkit/src/main/java/com/haishinkit/screen/scene/ScreenObjectSnapshotFactory.kt
@@ -9,6 +9,7 @@ class ScreenObjectSnapshotFactory {
             is ScreenObjectContainer -> {
                 ScreenObjectSnapshot(
                     type = screenObject.type,
+                    id = screenObject.id,
                     frame =
                         ScreenObjectSnapshot.Rect(
                             screenObject.frame.top,
@@ -30,6 +31,7 @@ class ScreenObjectSnapshotFactory {
             else -> {
                 ScreenObjectSnapshot(
                     type = screenObject.type,
+                    id = screenObject.id,
                     frame =
                         ScreenObjectSnapshot.Rect(
                             screenObject.frame.top,
diff --git a/lottie/src/main/java/com/haishinkit/lottie/LottieScreen.kt b/lottie/src/main/java/com/haishinkit/lottie/LottieScreen.kt
@@ -29,7 +29,8 @@ import kotlin.math.min
 @Suppress("MemberVisibilityCanBePrivate", "UNUSED")
 class LottieScreen(
     val context: Context,
-) : ImageScreenObject() {
+    id: String? = null,
+) : ImageScreenObject(id) {
     private interface Keys {
         companion object {
             const val ANIMATION_RES_ID = "animationResId"

Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,7 @@ internal class PixelTransform(`
`160`	`160`	`video.videoSize = Size(screen.frame.width(), screen.frame.height())`
`161`	`161`	`}`
`162`	`162`	`if (video.shouldInvalidateLayout) {`
`163`		`- video.id = screen.id`
	`163`	`+ video.textureId = screen.textureId`
`164`	`164`	`video.layout(renderer)`
`165`	`165`	`}`
`166`	`166`	`program?.use()`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ internal class Screen(`
`27`	`27`
`28`	`28`	`private var textureIds = intArrayOf(0)`
`29`	`29`
`30`		`- override var id: Int`
	`30`	`+ override var textureId: Int`
`31`	`31`	`get() = framebuffer.textureId`
`32`	`32`	`set(value) {`
`33`	`33`	`}`
`@@ -56,27 +56,27 @@ internal class Screen(`
`56`	`56`	`is VideoScreenObject -> {`
`57`	`57`	`val track = screenObject.track`
`58`	`58`	`videoTextureRegistry.getTextureIdByTrack(track)?.let { id ->`
`59`		`- screenObject.id = id`
	`59`	`+ screenObject.textureId = id`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`else -> {`
`64`	`64`	`GLES20.glGenTextures(1, textureIds, 0)`
`65`		`- screenObject.id = textureIds[0]`
	`65`	`+ screenObject.textureId = textureIds[0]`
`66`	`66`	`}`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`override fun unbind(screenObject: ScreenObject) {`
`71`	`71`	`when (screenObject) {`
`72`	`72`	`is VideoScreenObject -> {`
`73`		`- screenObject.id = 0`
	`73`	`+ screenObject.textureId = 0`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`else -> {`
`77`		`- textureIds[0] = screenObject.id`
	`77`	`+ textureIds[0] = screenObject.textureId`
`78`	`78`	`GLES20.glDeleteTextures(1, textureIds, 0)`
`79`		`- screenObject.id = 0`
	`79`	`+ screenObject.textureId = 0`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`	`}`
`@@ -90,9 +90,9 @@ internal class Screen(`
`90`	`90`	`} else {`
`91`	`91`	`videoTextureRegistry.register(track, video)`
`92`	`92`	`videoTextureRegistry.getTextureIdByTrack(track)?.let { id ->`
`93`		`- getScreenObjects(VideoScreenObject::class.java).forEach {`
	`93`	`+ findByClass(VideoScreenObject::class.java).forEach {`
`94`	`94`	`if (it.track == track) {`
`95`		`- it.id = id`
	`95`	`+ it.textureId = id`
`96`	`96`	`it.videoSize = video.videoSize`
`97`	`97`	`it.imageOrientation = video.imageOrientation`
`98`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@ internal class ThreadScreen(`
`21`	`21`	`return screen.graphicsContext`
`22`	`22`	`}`
`23`	`23`
`24`		`- override var id: Int`
`25`		`- get() = screen.id`
	`24`	`+ override var textureId: Int`
	`25`	`+ get() = screen.textureId`
`26`	`26`	`set(value) {`
`27`	`27`	`}`
`28`	`28`
`@@ -138,9 +138,15 @@ internal class ThreadScreen(`
`138`	`138`	`}`
`139`	`139`	`}`
`140`	`140`
`141`		`- override fun <T : ScreenObject> getScreenObjects(clazz: Class<T>): List<T> {`
	`141`	`+ override fun <T : ScreenObject> findByClass(clazz: Class<T>): List<T> {`
`142`	`142`	`return handler.run {`
`143`		`- screen.getScreenObjects(clazz)`
	`143`	`+ screen.findByClass(clazz)`
	`144`	`+ }`
	`145`	`+ }`
	`146`	`+`
	`147`	`+ override fun findById(targetId: String): ScreenObject? {`
	`148`	`+ return handler.run {`
	`149`	`+ screen.findById(targetId)`
`144`	`150`	`}`
`145`	`151`	`}`
`146`	`152`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ class MediaMixer(`
`89`	`89`	`val windowManager =`
`90`	`90`	`context.getSystemService(Context.WINDOW_SERVICE) as WindowManager`
`91`	`91`	`windowManager.defaultDisplay?.orientation?.let { orientation ->`
`92`		`- screen.getScreenObjects(VideoScreenObject::class.java).forEach {`
	`92`	`+ screen.findByClass(VideoScreenObject::class.java).forEach {`
`93`	`93`	`it.deviceOrientation = orientation`
`94`	`94`	`}`
`95`	`95`	`}`
`@@ -145,7 +145,7 @@ class MediaMixer(`
`145`	`145`	`track: Int,`
`146`	`146`	`videoEffect: VideoEffect,`
`147`	`147`	`) {`
`148`		`- screen.getScreenObjects(VideoScreenObject::class.java).forEach {`
	`148`	`+ screen.findByClass(VideoScreenObject::class.java).forEach {`
`149`	`149`	`if (it.track == track) {`
`150`	`150`	`it.videoEffect = videoEffect`
`151`	`151`	`}`