Dev

.github/workflows/build.yml

@@ -9,18 +9,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-java@v3
+      - uses: actions/setup-java@v4
         with:
           java-version: 17
           distribution: 'adopt'
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
-      - name: Build
-        run: ./gradlew build
       - name: Assemble
-        run: ./gradlew assembleDebug
+        run: ./gradlew assemble
       - name: Upload APKs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: apks
           path: |

.github/workflows/codeql.yml

@@ -45,7 +45,7 @@ jobs:
       matrix:
         include:
         - language: java-kotlin
-          build-mode: autobuild
+          build-mode: manual
         # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
         # Use `c-cpp` to analyze code written in C, C++ or both
         # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
@@ -84,13 +84,7 @@ jobs:
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
     - if: matrix.build-mode == 'manual'
       shell: bash
-      run: |
-        echo 'If you are using a "manual" build mode for one or more of the' \
-          'languages you are analyzing, replace this with the commands to build' \
-          'your code, for example:'
-        echo '  make bootstrap'
-        echo '  make release'
-        exit 1
+      run: ./gradlew --scan --full-stacktrace -Dorg.gradle.dependency.verification=off compileDebugAndroidTestSources
 
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v3

.github/workflows/docs.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-java@v3
+      - uses: actions/setup-java@v4
         with:
           java-version: 17
           distribution: 'adopt'

.github/workflows/release.yml

@@ -12,22 +12,22 @@ jobs:
       packages: write
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-java@v3
+      - name: Set up JDK
+        uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'adopt'
+      - name: Setup git config (for patch command)
+        run: |
+          git config --global user.name "GitHub Actions Bot"
+          git config --global user.email "<>"
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
-      - name: Validate Gradle wrapper
-        uses: gradle/wrapper-validation-action@v1
-      - name: Decode the secret key
-        run: echo $GPG_KEYRING_FILE_CONTENT | base64 --decode > ~/secring.gpg
-        env:
-          GPG_KEYRING_FILE_CONTENT: "${{ secrets.GPG_KEYRING_FILE_CONTENT }}"
       - name: Publish package
-        run: ./gradlew publish -Psigning.secretKeyRingFile=$(echo ~/secring.gpg) -Psigning.password=$GPG_PASSPHRASE -Psigning.keyId=$GPG_KEY_ID
+        run: ./gradlew publish
         env:
           MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+          GPG_KEY: ${{ secrets.GPG_KEY }}
           GPG_KEY_ID: ${{ secrets.GPG_KEY_ID }}
-          GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+          GPG_PASSWORD: ${{ secrets.GPG_PASSWORD }}

.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-java@v3
+      - uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'adopt'
@@ -29,7 +29,7 @@ jobs:
     timeout-minutes: 55
     strategy:
       matrix:
-        api-level: [ 26, 34 ]
+        api-level: [ 34 ]
     steps:
       - name: Enable KVM group perms
         run: |
@@ -51,10 +51,20 @@ jobs:
           arch: x86_64
           disable-animations: true
           emulator-options: -no-snapshot -no-window -no-boot-anim -camera-back emulated -camera-front emulated -gpu swiftshader_indirect
-          script: ./gradlew connectedCheck
+          script: |
+            adb root
+            adb logcat -c
+            touch emulator.log
+            chmod 777 emulator.log
+            adb logcat >> emulator.log &
+            ./gradlew -Pandroid.testInstrumentationRunnerArguments.INTEGRATION_TESTS_API_KEY=$INTEGRATION_TESTS_API_KEY connectedCheck
+        env:
+          INTEGRATION_TESTS_API_KEY: ${{ secrets.INTEGRATION_TESTS_API_KEY }}
       - name: Upload test reports
         if: ${{ !cancelled() }}
         uses: actions/upload-artifact@v4
         with:
           name: test-reports-${{ matrix.api-level }}
-          path: '**/build/reports/androidTests'
+          path: |
+            '**/build/reports/androidTests'
+            emulator.log

.gitignore

@@ -7,3 +7,4 @@ build
 /captures
 .externalNativeBuild
 .cxx
+.kotlin

DEVELOPER_README.md

@@ -12,64 +12,70 @@ microphone (`AudioSource`).
 A class that represents an audio or video encoders. Only Android MediaCodec API is used (
 `MediaCodecEncoder`).
 
+`Endpoint`:
+The last element of a live streaming pipeline. It is responsible for handling the frames after the
+encoder.
+The endpoint could be a remote server (RTMP, SRT,...) or a file (FLV, MPEG-TS,...).
+The main endpoint is `CompositeEndpoint` that is composed of a `Muxer` and a `Sink`.
+
 `Muxer`:
-A class that packs audio and video frames to a container (FLV, MPEG-TS, MP4,...).
+A process that packs audio and video frames to a container (FLV, MPEG-TS, MP4,...).
+The `CompositeEndpoint` is composed of a `IMuxer`.
 
-`Endpoint`:
-The last element of a live streaming pipeline. It is responsible for sending the audio and video
-streams somewhere For example, a file (`FileWriter`), or a remote RTMP server (`RtmpProducer`).
+`Sink`:
+A process that sends the container to a remote server (RTMP, SRT,...) or to a file.
+The `CompositeEndpoint` is composed of a `ISink`.
 
 `Streamer`:
 A class that represent a audio and/or video live streaming pipeline. It manages sources, encoders,
 muxers, endpoints,... and have lot of tools. They are the most important class for users.
-
-![streamer.png](https://github.com/ThibaultBee/StreamPack/blob/master/docs/assets/streamer.png)
+Unless explicitly stated, the `Endpoint` is inferred from the `MediaDescriptor` object thanks to
+the `DynamicEndpoint`.
 
 `Streamer element`:
-Could be a `Source`, `Encoder`, `Muxer`, or `Endpoint`. They implement the `Streamable<T>`.
+Could be a `Source`, `Encoder`, `Muxer`, or `Endpoint`. They implement the `Streamable<T>` and they
+might have a public interface to access specific info.
 
-`Helper`:
+`Info`:
 A class that provides a set of methods to help to `streamer` configuration such as supported
 resolutions,... It comes with an instantiated `Streamer` object:
 
 ```kotlin
-val helper = streamer.helper
+val info = streamer.getInfo(MediaDescriptor(`media uri`))
 ```
 
 They might be different for each `Streamer` object. For example, a `FlvStreamer` object will not
-have the same `Helper` object as a `TsStreamer` object because FLV does not support a wide range of
+have the same `Info` object as a `TsStreamer` object because FLV does not support a wide range of
 codecs, audio sample rate,...
 
 `Settings`:
-A class that adds settings to the `Streamer` object. For example, you can access camera settings,
-encoders bitrate,... It comes with an instantiated `Streamer` object:
+Each streamer elements have a public interface that allows go have access to specific
+information or configuration.
+For example, the `VideoEncoder` object has a `bitrate` property that allows to get and set the
+current video bitrate.
+Example:
 
 ```kotlin
-val settings = streamer.settings
+// Get video bitrate
+val bitrate = streamer.videoEncoder!!.bitrate
+// Set video bitrate on the fly
+streamer.videoEncoder!!.bitrate = 2000000
 ```
 
-They might be different for each `Streamer` object. For example, only `CameraStreamer` have a camera
-settings.
-
-`Extensions`:
-A library that adds new features from native libraries. It often comes with a `Streamer elements`
-and specific pipelines.
-
 ## Streamers
 
-The base streamer class is `BaseStreamer`. All other streamers inherit from it. Then 2 specifics
+The streamer implementation is the `DefaultStreamer`. All other streamers inherit from it. Then 2
+specifics
 base streamers inherit from it:
 
-- `BaseCameraStreamer`: A streamer that streams from a camera and microphone. It adds `startPreview`
+- `DefaultCameraStreamer`: A streamer that streams from a camera and microphone. It
+  adds `startPreview`
   , `stopPreview` methods to the `Streamer` object as well as a camera settings.
-- `BaseScreenRecorderStreamer`: A streamer that streams from the phone screen and microphone. It
+- `DefaultScreenRecorderStreamer`: A streamer that streams from the phone screen and microphone. It
   adds specific methods for screen recorder as a API to set activity result.
 
-Then these base streamers are specialized for a File or for a Live:
-
-- `BaseFileStreamer`: A streamer that streams to a file. That means you will find
-  `BaseFileStreamer` for MPEG-TS and one for FLV.
-- `BaseLiveStreamer`: A streamer that streams to a remote server (RTMP or SRT both in `extensions`).
+To endpoint of a `Streamer` is inferred from the `MediaDescriptor` object passed to the `Streamer`
+by `open` or `startStream` methods.
 
 ## Sources
 
@@ -81,6 +87,21 @@ There are 2 types of sources:
   a `Surface`. Its purpose is to improve encoder performance. For example, it suits camera and
   screen recorder. `Surface` sources implement `ISurfaceSource`.
 
+@startuml
+interface IVideoSource {
+
++ hasSurface: Boolean
++ encoderSurface: Surface?
++ getFrame(): ByteBuffer
+  }
+
+interface IAudioSource {
+
++ getFrame(): ByteBuffer
+  }
+  @enduml
++
+
 To create a new audio source, implements a `IAudioSource`. It inherits from `IFrameSource`.
 
 To create a new video source, implements a `IVideSource`. It inherits from both `IFrameCapture`
@@ -100,13 +121,69 @@ If your video source is a `ByteBuffer` source, set:
 
 ## Encoders
 
-Both `AudioMediaCodecEncoder` and `VideoMediaCodecEncoder` inherit from `MediaCodecEncoder`. They
-are using Android `MediaCodec` API in asynchronous mode.
+The only encoder is based on Android `MediaCodec` API. It implements the `IEncoder` interface.
 
-## Muxers
-
-They implement the `IMuxer` interface.
+@startuml
+interface IEncoder {
+}
+@enduml
 
 ## Endpoints
 
-They implement the `IEndpoint` interface. Use specific `ILiveEndpoint` for live streaming.
+They implement the `IEndpoint` interface.
+
+@startuml
+interface IEndpoint {
+
++ open()
++ close()
++ write()
+  }
+
+class CompositeEndpoint {
+
++ muxer: IMuxer
++ sink: ISink
+  }
+  @enduml
+
+### Muxers
+
+They implement the `IMuxer` interface.
+
+### Sinks
+
+They implement the `ISink` interface.
+
+### Streamers
+
+The implement the `ICoroutineStreamer` interface.
+
+@startuml
+class DefaultStreamer {
+
++ videoSource: IVideoSource
++ audioSource: IAudioSource
++ endoint: IEndpoint
+
+- videoEncoder: IEncoder
+- audioEncoder: IEncoder
+  }
+  @enduml
+
+@startuml
+rectangle DefaultCameraStreamer {
+[CameraSource] as VideoSource
+[MicrophoneSource] as AudioSource
+[Encoder] as VideoEncoder
+[Encoder] as AudioEncoder
+[Endpoint] as Endpoint
+VideoSource -r-> VideoEncoder
+AudioSource -r-> AudioEncoder
+VideoEncoder -r-> Endpoint
+AudioEncoder -r-> Endpoint
+AudioSource -d[hidden]-> VideoSource
+AudioEncoder -d[hidden]-> VideoEncoder
+}
+}
+@enduml