fu flv

Author: ThibaultBee

.github/workflows/documentation.yml

@@ -21,8 +21,8 @@ jobs:
           ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_IN_MEMORY_KEY }}
           ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
           ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
-          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.OSSRH_USERNAME }}
-          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.OSSRH_TOKEN }}
+          ORG_GRADLE_PROJECT_centralPortalUsername: ${{ secrets.CENTRAL_PORTAL_USERNAME }}
+          ORG_GRADLE_PROJECT_centralPortalPassword: ${{ secrets.CENTRAL_PORTAL_PASSWORD }}
       - name: Generate documentation
         run: ./gradlew dokkaHtmlMultiModule
       - name: Deploy API documentation to Github Pages

.github/workflows/release.yml

@@ -6,11 +6,11 @@ A RTMP client and server (soon) library for Kotlin Multiplatform.
 
 Features:
 
-- [x] RTMP publish client
-- [ ] RTMP play client
-- [ ] RTMP play2 client
-- [ ] RTMP server
+- [x] RTMP client
+- [x] RTMP server
 - [ ] Statistics
+- [x] Support for legacy RTMP
+- [x] Support for enhanced RTMP v2: AV1, HEVC, VP8, VP9
 
 Supported protocols:
 
@@ -23,15 +23,17 @@ Supported protocols:
 Adds the following dependency to your project:
 
 ```kotlin
-implementation("io.github.thibaultbee.krtmp:rtmp:1.0.0")
+implementation("io.github.thibaultbee.krtmp:rtmp:0.9.0")
 ```
 
 ## Usage
 
-Creates a RTMP publish client with the Factory `RtmpClientConnectionFactory`:
+### Client
+
+Creates a RTMP client with the Factory `RtmpClient`:
 
 ```kotlin
-val client = RtmpPublishClientConnectionFactory().create(
+val client = RtmpClient(
     "rtmp://my.server.com/app/streamkey" // Your RTMP server URL (incl app name and stream key)
 )
 ```
@@ -41,18 +43,9 @@ Then prepare your live by sending these messages to the server:
 ```kotlin
 client.connect()
 client.createStream()
-client.publish(Command.Publish.Type.LIVE)
-```
-
-If you have raw audio and video frames, you need to mux them into FLV tag headers. You can use
-the `FlvMuxer` class for that.
-
-```kotlin
-val flvMuxer = client.flvMuxer
+client.publish(StreamPublishType.LIVE)
 ```
 
-See [FLV](#flv) for more details to write audio and video frames..
-
 If you already have FLV data, write your video/audio data:
 
 ```kotlin
@@ -72,7 +65,21 @@ try {
 }
 ```
 
-For advanced configuration, see `RtmpClientSettings`.
+See [FLV](#flv) for more details to write audio and video frames..
+
+### Server
+
+Use the `RtmpServer` to create a RTMP server:
+
+```kotlin
+val server = RtmpServer("0.0.0.0:1935") // Listening on port 1935
+```
+
+Then start the server:
+
+```kotlin
+server.listen()
+```
 
 # FLV
 
@@ -84,52 +91,53 @@ Features:
 - [x] Demuxer for FLV
 - [x] AMF0 metadata
 - [ ] AMF3 metadata
-- [x] Supported audio codec: AAC
-- [x] Supported video codec: AVC/H.264 and enhanced RTMP codecs: HEVC/H.265, VP9, AV1
+- [x] Support for legacy RTMP
+- [x] Support for enhanced RTMP v1: AV1, HEVC, VP8, VP9
+- [x] Support for enhanced RTMP v2: Multitrack, Opus,...
 
 ## Installation
 
 Adds the following dependencies to your project:
 
 ```kotlin
-implementation("io.github.thibaultbee.krtmp:flv:1.0.0")
+implementation("io.github.thibaultbee.krtmp:flv:0.9.0")
 ```
 
 ## Usage
 
 Creates a FLV muxer and add audio/video data:
 
 ```kotlin
-val muxer = FlvMuxer()
+val muxer = FLVMuxer(path = "/path/to/file.flv")
+
+// Write FLV header
+flvMuxer.encodeFlvHeader(hasAudio, hasVideo)
 
 // Register audio configurations (if any)
-val audioConfig = FlvAudioConfig(
+val audioConfig = FLVAudioConfig(
     FlvAudioConfig.SoundFormat.AAC,
     FlvAudioConfig.SoundRate.KHZ44,
     FlvAudioConfig.SoundSize.SND8BIT,
     FlvAudioConfig.SoundType.STEREO
 )
-val audioId = muxer.addStream(audioConfig)
-
-// Register audio configurations (if any)
-val videoConfig = FlvVideoConfig(
-
+// Register video configurations (if any)
+val videoConfig = FLVVideoConfig(
 )
-val videoId = muxer.addStream(videoConfig)
 
-// Start the muxer (write FlvTag (if needed) and onMetaData)
-muxer.startStream()
+// Write onMetadata
+muxer.encode(0, OnMetadata(audioConfig, videoConfig))
 
 // Write audio/video data
-muxer.write(audioFrame)
-muxer.write(videoFrame)
-muxer.write(audioFrame)
-muxer.write(videoFrame)
-// till you're done
+muxer.encode(audioFrame)
+muxer.encode(videoFrame)
+muxer.encode(audioFrame)
+muxer.encode(videoFrame)
 
-// Stop the muxer
-muxer.stopStream()
+// Till you're done, then
+muxer.flush()
 
+// Close the output
+muxer.close()
 ```
 
 # AMF
@@ -140,7 +148,7 @@ Features:
 
 - [x] Serializer for AMF0
 - [ ] Serializer for AMF3
-- [ ] Deserializer for AMF0
+- [x] Deserializer for AMF0
 - [ ] Deserializer for AMF3
 
 ## Installation
@@ -151,7 +159,7 @@ details.
 Then, adds the following dependencies to your project:
 
 ```kotlin
-implementation("io.github.thibaultbee.krtmp:amf:1.0.0")
+implementation("io.github.thibaultbee.krtmp:amf:0.9.0")
 ```
 
 ## Usage
@@ -172,7 +180,7 @@ val array = Amf.encodeToByteArray(MyData.serializer(), data)
 
 # TODO
 
-- [x] A FLV/RTMP parameter for supported level: (legacy, enhanced v1, enhanced v2,...)
+- [ ] More tests (missing tests samples)
 
 # Licence
 

README.md

@@ -27,7 +27,7 @@ kotlin {
         compilations.all {
             compileTaskProvider.configure {
                 compilerOptions {
-                    jvmTarget.set(JvmTarget.JVM_1_8)
+                    jvmTarget.set(JvmTarget.JVM_18)
                 }
             }
         }
@@ -68,7 +68,7 @@ kotlin {
 
 android {
     namespace = "io.github.thibaultbee.krtmp.amf"
-    compileSdk = 34
+    compileSdk = 36
     defaultConfig {
         minSdk = 21
     }

amf/build.gradle.kts

@@ -163,19 +163,19 @@ data class AmfConfiguration(
     /**
      * Specifies whether default values of Kotlin properties should be encoded.
      */
-    val encodeDefaults: Boolean = false,
+    val encodeDefaults: Boolean = true,
 
     /**
      * Specifies whether encounters of unknown properties in the input AMF
      * should be ignored instead of throwing [SerializationException].
      * `false` by default.
      */
-    val ignoreUnknownKeys: Boolean = false,
+    val ignoreUnknownKeys: Boolean = true,
 
     /**
      * Specifies whether nulls should be encoded as explicit AMF nulls.
      *
      * When this flag is disabled properties with `null` values without default are not encoded.
      */
-    val explicitNulls: Boolean = true
+    val explicitNulls: Boolean = false
 )

amf/src/commonMain/kotlin/io/github/thibaultbee/krtmp/amf/Amf.kt

@@ -15,27 +15,29 @@
  */
 package io.github.thibaultbee.krtmp.amf.elements
 
-import io.github.thibaultbee.krtmp.amf.elements.containers.AmfContainer
-import io.github.thibaultbee.krtmp.amf.elements.containers.AmfEcmaArray
-import io.github.thibaultbee.krtmp.amf.elements.containers.AmfObject
-import io.github.thibaultbee.krtmp.amf.elements.containers.AmfStrictArray
+import io.github.thibaultbee.krtmp.amf.elements.containers.amfContainerOf
+import io.github.thibaultbee.krtmp.amf.elements.containers.amfEcmaArrayOf
+import io.github.thibaultbee.krtmp.amf.elements.containers.amfObjectOf
+import io.github.thibaultbee.krtmp.amf.elements.containers.amfStrictArrayOf
 import io.github.thibaultbee.krtmp.amf.elements.primitives.AmfBoolean
-import io.github.thibaultbee.krtmp.amf.elements.primitives.AmfDate
 import io.github.thibaultbee.krtmp.amf.elements.primitives.AmfNull
 import io.github.thibaultbee.krtmp.amf.elements.primitives.AmfNumber
 import io.github.thibaultbee.krtmp.amf.elements.primitives.AmfString
-import kotlinx.datetime.Instant
+import io.github.thibaultbee.krtmp.amf.elements.primitives.amfDateOf
 import kotlinx.io.IOException
+import kotlin.time.ExperimentalTime
+import kotlin.time.Instant
 
 object AmfElementFactory {
-    fun buildContainer(value: List<Any?>) = AmfContainer(value)
+    fun buildContainer(value: List<Any?>) = amfContainerOf(value)
 
-    fun buildEcmaArray(value: Map<String, Any?>) = AmfEcmaArray(value)
+    fun buildEcmaArray(value: Map<String, Any?>) = amfEcmaArrayOf(value)
 
-    fun buildObject(value: Map<String, Any?>) = AmfObject(value)
+    fun buildObject(value: Map<String, Any?>) = amfObjectOf(value)
 
-    fun buildStrictArray(value: List<Any?>) = AmfStrictArray(value)
+    fun buildStrictArray(value: List<Any?>) = amfStrictArrayOf(value)
 
+    @OptIn(ExperimentalTime::class)
     fun build(value: Any?): AmfElement {
         if (value == null) {
             return AmfNull()
@@ -45,15 +47,16 @@ object AmfElementFactory {
             is Boolean -> AmfBoolean(value)
             is Double -> AmfNumber(value)
             is String -> AmfString(value)
-            is List<*> -> AmfStrictArray(value)
-            is Instant -> AmfDate(value)
+            is List<*> -> amfStrictArrayOf(value)
+            is Instant -> amfDateOf(value)
             is Map<*, *> -> {
                 if (value.keys.any { it !is String }) {
                     throw IOException("AMF ECMA array keys must be String. At least one is not a String in ${value.keys}")
                 }
                 @Suppress("UNCHECKED_CAST")
-                AmfEcmaArray(value as Map<String, Any?>)
+                amfEcmaArrayOf(value as Map<String, Any?>)
             }
+
             else -> throw IOException("Can't build an AmfParameter for ${value::class.simpleName}: $value")
         }
     }

amf/src/commonMain/kotlin/io/github/thibaultbee/krtmp/amf/elements/AmfElementFactory.kt

@@ -15,15 +15,15 @@
  */
 package io.github.thibaultbee.krtmp.amf.elements
 
-import io.github.thibaultbee.krtmp.amf.elements.containers.Amf0Container
-import io.github.thibaultbee.krtmp.amf.elements.containers.Amf0EcmaArray
-import io.github.thibaultbee.krtmp.amf.elements.containers.Amf0Object
-import io.github.thibaultbee.krtmp.amf.elements.containers.Amf0StrictArray
-import io.github.thibaultbee.krtmp.amf.elements.primitives.Amf0Boolean
-import io.github.thibaultbee.krtmp.amf.elements.primitives.Amf0Date
-import io.github.thibaultbee.krtmp.amf.elements.primitives.Amf0Null
-import io.github.thibaultbee.krtmp.amf.elements.primitives.Amf0Number
-import io.github.thibaultbee.krtmp.amf.elements.primitives.Amf0String
+import io.github.thibaultbee.krtmp.amf.elements.containers.amf0ContainerFrom
+import io.github.thibaultbee.krtmp.amf.elements.containers.amf0EcmaArrayFrom
+import io.github.thibaultbee.krtmp.amf.elements.containers.amf0ObjectFrom
+import io.github.thibaultbee.krtmp.amf.elements.containers.amf0StrictArrayFrom
+import io.github.thibaultbee.krtmp.amf.elements.primitives.amf0BooleanFrom
+import io.github.thibaultbee.krtmp.amf.elements.primitives.amf0DateFrom
+import io.github.thibaultbee.krtmp.amf.elements.primitives.amf0NullFrom
+import io.github.thibaultbee.krtmp.amf.elements.primitives.amf0NumberFrom
+import io.github.thibaultbee.krtmp.amf.elements.primitives.amf0StringFrom
 import kotlinx.io.IOException
 import kotlinx.io.Source
 
@@ -41,25 +41,25 @@ interface AmfElementReader {
 
 object Amf0ElementReader : AmfElementReader {
     override fun readContainer(numOfElements: Int, source: Source) =
-        Amf0Container(numOfElements, source)
+        amf0ContainerFrom(numOfElements, source)
 
-    override fun readEcmaArray(source: Source) = Amf0EcmaArray(source)
+    override fun readEcmaArray(source: Source) = amf0EcmaArrayFrom(source)
 
-    override fun readObject(source: Source) = Amf0Object(source)
+    override fun readObject(source: Source) = amf0ObjectFrom(source)
 
-    override fun buildStrictArray(source: Source) = Amf0StrictArray(source)
+    override fun buildStrictArray(source: Source) = amf0StrictArrayFrom(source)
 
     override fun read(source: Source): AmfElement {
         return when (val type = source.peek().readByte()) {
-            Amf0Type.NUMBER.value -> Amf0Number(source)
-            Amf0Type.BOOLEAN.value -> Amf0Boolean(source)
-            Amf0Type.STRING.value -> Amf0String(source)
-            Amf0Type.LONG_STRING.value -> Amf0String(source)
-            Amf0Type.OBJECT.value -> Amf0Object(source)
-            Amf0Type.NULL.value -> Amf0Null(source)
-            Amf0Type.ECMA_ARRAY.value -> Amf0EcmaArray(source)
-            Amf0Type.STRICT_ARRAY.value -> Amf0StrictArray(source)
-            Amf0Type.DATE.value -> Amf0Date(source)
+            Amf0Type.NUMBER.value -> amf0NumberFrom(source)
+            Amf0Type.BOOLEAN.value -> amf0BooleanFrom(source)
+            Amf0Type.STRING.value -> amf0StringFrom(source)
+            Amf0Type.LONG_STRING.value -> amf0StringFrom(source)
+            Amf0Type.OBJECT.value -> amf0ObjectFrom(source)
+            Amf0Type.NULL.value -> amf0NullFrom(source)
+            Amf0Type.ECMA_ARRAY.value -> amf0EcmaArrayFrom(source)
+            Amf0Type.STRICT_ARRAY.value -> amf0StrictArrayFrom(source)
+            Amf0Type.DATE.value -> amf0DateFrom(source)
             else -> throw IOException("Invalid AMF0 type: $type")
         }
     }