improve recorder and mixer. also readme

Author: maxnut

.github/workflows/multi-platform.yml

@@ -0,0 +1,55 @@
+name: Build Geode Mod
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "**"
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+        - name: Windows
+          os: windows-latest
+
+        - name: macOS
+          os: macos-latest
+
+        - name: Android32
+          os: ubuntu-latest
+          target: Android32
+
+        - name: Android64
+          os: ubuntu-latest
+          target: Android64
+
+    name: ${{ matrix.config.name }}
+    runs-on: ${{ matrix.config.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build the mod
+        uses: geode-sdk/build-geode-mod@main
+        with:
+          bindings: geode-sdk/bindings
+          bindings-ref: main
+          combine: true
+          target: ${{ matrix.config.target }}
+
+  package:
+    name: Package builds
+    runs-on: ubuntu-latest
+    needs: ['build']
+
+    steps:
+      - uses: geode-sdk/build-geode-mod/combine@main
+        id: build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Build Output
+          path: ${{ steps.build.outputs.build-output }}

README.md

@@ -1 +1,62 @@
-# ffmpeg-api
+# ffmpeg-api
+A mod that lets developers easily interact with ffmpeg to record raw videos, and mix video and audio files.
+
+## Usage
+
+### Record videos
+
+```cpp
+#include <eclipse.ffmpeg-api/include/recorder.hpp>
+
+void video() {
+    ffmpeg::Recorder recorder;
+
+    RenderSettings settings;
+
+    //ffmpeg-api will automatically handle conversion between the input pixel
+    //format and the codec's pixel format
+    settings.m_pixelFormat = PixelFormat::RGB0;
+    settings.m_codec = "h264_nvenc";
+    settings.m_bitrate = 30000000;
+    settings.m_width = 1920;
+    settings.m_height = 1080;
+    settings.m_fps = 60;
+    settings.m_outputFile = "output_video.mp4";
+
+    //insert your raw data here
+    std::vector<uint8_t> frame;
+
+    recorder.init(settings);
+
+    for(int i = 0; i < 60; i++)
+        recorder.writeFrame(frame);
+
+    recorder.stop();
+}
+```
+
+### Mix audio
+
+```cpp
+#include <eclipse.ffmpeg-api/include/audio_mixer.hpp>
+
+void audioFile() {
+    ffmpeg::AudioMixer mixer;
+    mixer.mixVideoAudio("video.mp4", "audio.mp3", "output_mp3.mp4");
+    mixer.mixVideoAudio("video.mp4", "audio.wav", "output_wav.mp4");
+}
+
+void audioRaw() {
+    ffmpeg::AudioMixer mixer;
+
+    //insert your raw data here
+    std::vector<float> raw;
+    mixer.mixVideoRaw("video.mp4", raw, "output_raw.mp4", 44100);
+}
+```
+
+## Build instructions
+### Windows
+To get the needed libraries on Windows, you can use vcpkg
+```sh
+vcpkg install ffmpeg[core,avcodec,avformat,avutil,swscale,swresample,amf,x264,x265,nvcodec]:x64-windows-static --recurse

about.md

@@ -1,3 +1,3 @@
-# Template Mod
+# ffmpeg-api
 
-Edit about.md to change this
+A mod that lets developers easily interact with ffmpeg to record raw videos, and mix video and audio files.

include/audio_mixer.hpp

@@ -8,7 +8,36 @@ namespace ffmpeg {
 
 class FFMPEG_API_DLL AudioMixer {
 public:
-    void mixMp4Wav(std::filesystem::path mp4File, std::filesystem::path wavFile, std::filesystem::path outputMp4File);
+    /**
+     * @brief Mixes a video file and an audio file into a single MP4 output.
+     *
+     * This function takes an input video file and an audio file, and merges them into a single MP4 output file. 
+     * The output MP4 file will have both the video and audio streams synchronized.
+     *
+     * @param videoFile The path to the input video file.
+     * @param audioFile The path to the input audio file.
+     * @param outputMp4File The path where the output MP4 file will be saved.
+     * 
+     * @warning The audio file is expected to contain stereo (dual-channel) audio. Using other formats might lead to unexpected results.
+     * @warning The video file is expected to contain a single video stream. Only the first video stream will be copied.
+     */
+    void mixVideoAudio(std::filesystem::path videoFile, std::filesystem::path audioFile, std::filesystem::path outputMp4File);
+
+    /**
+     * @brief Mixes a video file and raw audio data into a single MP4 output.
+     *
+     * This function takes an input video file and raw audio data (in the form of a vector of floating-point samples), 
+     * and merges them into a single MP4 output file. The audio codec parameters must also be provided to describe the format of the raw audio.
+     *
+     * @param videoFile The path to the input video file.
+     * @param raw A vector containing the raw audio data (floating-point samples).
+     * @param outputMp4File The path where the output MP4 file will be saved.
+     * @param sampleRate The sample rate of the raw audio data.
+     * 
+     * @warning The raw audio data is expected to be stereo (dual-channel). Using mono or multi-channel audio might lead to issues.
+     * @warning The video file is expected to contain a single video stream. Only the first video stream will be copied.
+     */
+    void mixVideoRaw(std::filesystem::path videoFile, const std::vector<float>& raw, std::filesystem::path outputMp4File, uint32_t sampleRate);
 };
 
 }