feat(core): annotate internal interfaces with @internalapi for better visibility

Author: ThibaultBee

core/src/main/java/io/github/thibaultbee/streampack/core/elements/encoders/IEncoder.kt

@@ -22,6 +22,7 @@ import io.github.thibaultbee.streampack.core.elements.interfaces.SuspendReleasab
 import io.github.thibaultbee.streampack.core.elements.interfaces.SuspendStreamable
 import kotlinx.coroutines.channels.SendChannel
 import java.nio.ByteBuffer
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 
 interface IEncoder {
     /**
@@ -60,6 +61,7 @@ interface IEncoder {
     fun requestKeyFrame()
 }
 
+@InternalAPI
 interface IEncoderInternal : SuspendStreamable, SuspendReleasable,
     IEncoder {
 

core/src/main/java/io/github/thibaultbee/streampack/core/elements/encoders/mediacodec/MediaCodecEncoder.kt

@@ -35,6 +35,7 @@ import io.github.thibaultbee.streampack.core.elements.utils.extensions.put
 import io.github.thibaultbee.streampack.core.elements.utils.extensions.removePrefixes
 import io.github.thibaultbee.streampack.core.elements.utils.pool.FramePool
 import io.github.thibaultbee.streampack.core.logger.Logger
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.SupervisorJob
@@ -51,6 +52,7 @@ import kotlin.math.min
  *
  * @param encoderConfig the encoder configuration
  */
+@OptIn(InternalAPI::class)
 internal class MediaCodecEncoder
 internal constructor(
     private val encoderConfig: EncoderConfig<*>,

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/CombineEndpoint.kt

@@ -24,6 +24,7 @@ import io.github.thibaultbee.streampack.core.elements.utils.extensions.intersect
 import io.github.thibaultbee.streampack.core.logger.Logger
 import io.github.thibaultbee.streampack.core.pipelines.IDispatcherProvider
 import io.github.thibaultbee.streampack.core.pipelines.utils.MultiThrowable
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineScope
@@ -43,6 +44,7 @@ import kotlinx.coroutines.launch
  * @param endpoints Endpoints to combine
  * @param coroutineDispatcher Coroutine dispatcher to use for frame writing
  */
+@OptIn(InternalAPI::class)
 fun CombineEndpoint(vararg endpoints: IEndpointInternal, coroutineDispatcher: CoroutineDispatcher) =
     CombineEndpoint(endpoints.toList(), coroutineDispatcher)
 
@@ -59,6 +61,7 @@ fun CombineEndpoint(vararg endpoints: IEndpointInternal, coroutineDispatcher: Co
  * @param endpointInternals List of endpoints to combine
  * @param coroutineDispatcher Coroutine dispatcher to use for frame writing
  */
+@OptIn(InternalAPI::class)
 open class CombineEndpoint(
     protected val endpointInternals: List<IEndpointInternal>,
     coroutineDispatcher: CoroutineDispatcher
@@ -284,12 +287,14 @@ open class CombineEndpoint(
 /**
  * A factory to build a [CombineEndpoint] from a varargs of [IEndpointInternal.Factory].
  */
+@OptIn(InternalAPI::class)
 fun CombineEndpointFactory(vararg endpointFactory: IEndpointInternal.Factory) =
     CombineEndpointFactory(endpointFactory.toList())
 
 /**
  * A factory to build a [CombineEndpoint] from a list of [IEndpointInternal.Factory].
  */
+@OptIn(InternalAPI::class)
 class CombineEndpointFactory(private val endpointFactory: List<IEndpointInternal.Factory>) :
     IEndpointInternal.Factory {
     override fun create(

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/DualEndpoint.kt

@@ -21,6 +21,7 @@ import androidx.core.net.toUri
 import io.github.thibaultbee.streampack.core.configuration.mediadescriptor.MediaDescriptor
 import io.github.thibaultbee.streampack.core.configuration.mediadescriptor.UriMediaDescriptor
 import io.github.thibaultbee.streampack.core.pipelines.IDispatcherProvider
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
@@ -37,6 +38,7 @@ import kotlinx.coroutines.sync.withLock
  * @param secondEndpoint the second endpoint
  * @param coroutineDispatcher the coroutine dispatcher
  */
+@OptIn(InternalAPI::class)
 open class DualEndpoint(
     private val mainEndpoint: IEndpointInternal,
     private val secondEndpoint: IEndpointInternal,
@@ -152,6 +154,7 @@ suspend fun DualEndpoint.startStreamSecond(uriString: String) =
 /**
  * A factory to build a [DualEndpoint].
  */
+@OptIn(InternalAPI::class)
 class DualEndpointFactory(
     private val mainEndpointFactory: IEndpointInternal.Factory,
     private val secondEndpointFactory: IEndpointInternal.Factory

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/DummyEndpoint.kt

@@ -20,13 +20,15 @@ import io.github.thibaultbee.streampack.core.configuration.mediadescriptor.Media
 import io.github.thibaultbee.streampack.core.elements.data.Frame
 import io.github.thibaultbee.streampack.core.elements.encoders.CodecConfig
 import io.github.thibaultbee.streampack.core.pipelines.IDispatcherProvider
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
 
 /**
  * A dummy endpoint for testing.
  */
+@OptIn(InternalAPI::class)
 class DummyEndpoint : IEndpointInternal {
     private val _isOpenFlow = MutableStateFlow(false)
     override val isOpenFlow = _isOpenFlow.asStateFlow()
@@ -75,6 +77,7 @@ class DummyEndpoint : IEndpointInternal {
 /**
  * The factory to create [DummyEndpoint].
  */
+@OptIn(InternalAPI::class)
 class DummyEndpointFactory : IEndpointInternal.Factory {
     override fun create(
         context: Context,
@@ -87,6 +90,7 @@ class DummyEndpointFactory : IEndpointInternal.Factory {
 /**
  * The factory to create [DummyEndpoint].
  */
+@OptIn(InternalAPI::class)
 class DummyEndpointDummyFactory(val dummyEndpoint: DummyEndpoint) : IEndpointInternal.Factory {
     override fun create(
         context: Context,

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/DynamicEndpoint.kt

@@ -31,6 +31,7 @@ import io.github.thibaultbee.streampack.core.elements.metrics.WithEndpointMetric
 import io.github.thibaultbee.streampack.core.elements.utils.ConflatedJob
 import io.github.thibaultbee.streampack.core.logger.Logger
 import io.github.thibaultbee.streampack.core.pipelines.IDispatcherProvider
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.cancelChildren
@@ -47,6 +48,7 @@ import kotlinx.coroutines.sync.withLock
  *
  * @param context The application context
  */
+@OptIn(InternalAPI::class)
 open class DynamicEndpoint(
     private val context: Context,
     private val defaultDispatcher: CoroutineDispatcher,
@@ -276,6 +278,7 @@ open class DynamicEndpoint(
 /**
  * A factory to build a [DynamicEndpoint].
  */
+@OptIn(InternalAPI::class)
 class DynamicEndpointFactory : IEndpointInternal.Factory {
     override fun create(
         context: Context,

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/DynamicLocalEndpoint.kt

@@ -18,6 +18,7 @@ package io.github.thibaultbee.streampack.core.elements.endpoints
 import android.content.Context
 import io.github.thibaultbee.streampack.core.configuration.mediadescriptor.MediaDescriptor
 import io.github.thibaultbee.streampack.core.pipelines.IDispatcherProvider
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.CoroutineDispatcher
 
 /**
@@ -42,6 +43,7 @@ class DynamicLocalEndpoint(
     }
 }
 
+@OptIn(InternalAPI::class)
 class DynamicLocalEndpointFactory : IEndpointInternal.Factory {
     override fun create(
         context: Context,

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/Endpoints.kt

@@ -6,12 +6,14 @@ import io.github.thibaultbee.streampack.core.elements.endpoints.composites.Compo
 import io.github.thibaultbee.streampack.core.elements.endpoints.composites.sinks.ISinkWithMetricsInternal
 import io.github.thibaultbee.streampack.core.elements.endpoints.composites.muxers.ts.TsMuxer
 import io.github.thibaultbee.streampack.core.elements.endpoints.composites.muxers.ts.data.TSServiceInfo
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.CoroutineDispatcher
 
 object Endpoints {
     /**
      * Creates an endpoint for RTMP (with a FLV muxer)
      */
+    @OptIn(InternalAPI::class)
     internal fun createRtmpEndpoint(
         defaultDispatcher: CoroutineDispatcher,
         ioDispatcher: CoroutineDispatcher
@@ -36,6 +38,7 @@ object Endpoints {
     /**
      * Creates an endpoint for FLV File
      */
+    @OptIn(InternalAPI::class)
     internal fun createFlvFileEndpoint(
         defaultDispatcher: CoroutineDispatcher,
         ioDispatcher: CoroutineDispatcher
@@ -61,6 +64,7 @@ object Endpoints {
     /**
      * Creates an endpoint for FLV File
      */
+    @OptIn(InternalAPI::class)
     internal fun createFlvContentEndpoint(
         context: Context,
         defaultDispatcher: CoroutineDispatcher,
@@ -90,6 +94,7 @@ object Endpoints {
     /**
      * Creates an endpoint for SRT (with a TS muxer)
      */
+    @OptIn(InternalAPI::class)
     internal fun createSrtEndpoint(
         serviceInfo: TSServiceInfo?,
         coroutineDispatcher: CoroutineDispatcher

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/IEndpoint.kt

@@ -25,7 +25,9 @@ import io.github.thibaultbee.streampack.core.elements.interfaces.SuspendReleasab
 import io.github.thibaultbee.streampack.core.elements.interfaces.SuspendStreamable
 import io.github.thibaultbee.streampack.core.pipelines.IDispatcherProvider
 import kotlinx.coroutines.flow.StateFlow
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 
+@InternalAPI
 interface IEndpointInternal : IEndpoint, SuspendStreamable,
     SuspendCloseable, SuspendReleasable {
 

core/src/main/java/io/github/thibaultbee/streampack/core/elements/endpoints/MediaMuxerEndpoint.kt

@@ -28,6 +28,7 @@ import io.github.thibaultbee.streampack.core.elements.data.Frame
 import io.github.thibaultbee.streampack.core.elements.encoders.CodecConfig
 import io.github.thibaultbee.streampack.core.logger.Logger
 import io.github.thibaultbee.streampack.core.pipelines.IDispatcherProvider
+import io.github.thibaultbee.streampack.core.utils.InternalAPI
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
@@ -40,6 +41,7 @@ import java.security.InvalidParameterException
 /**
  * An [IEndpointInternal] implementation of the [MediaMuxer].
  */
+@OptIn(InternalAPI::class)
 class MediaMuxerEndpoint(
     private val context: Context,
     private val ioDispatcher: CoroutineDispatcher
@@ -491,7 +493,9 @@ class MediaMuxerEndpoint(
 /**
  * Factory for [MediaMuxerEndpoint].
  */
-class MediaMuxerEndpointFactory : IEndpointInternal.Factory {
+@OptIn(InternalAPI::class)
+class MediaMuxerEndpointFactory :
+    IEndpointInternal.Factory {
     override fun create(
         context: Context, dispatcherProvider: IDispatcherProvider
     ): IEndpointInternal {