munim-ffmpeg 0.1.0

package/nitrogen/generated/shared/c++/HybridMunimFfmpegSpec.hpp

@@ -0,0 +1,72 @@
+///
+/// HybridMunimFfmpegSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `FFmpegSessionResult` to properly resolve imports.
+namespace margelo::nitro::munimffmpeg { struct FFmpegSessionResult; }
+
+#include <string>
+#include "FFmpegSessionResult.hpp"
+#include <NitroModules/Promise.hpp>
+#include <vector>
+#include <functional>
+#include <optional>
+
+namespace margelo::nitro::munimffmpeg {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `MunimFfmpeg`
+   * Inherit this class to create instances of `HybridMunimFfmpegSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridMunimFfmpeg: public HybridMunimFfmpegSpec {
+   * public:
+   *   HybridMunimFfmpeg(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridMunimFfmpegSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridMunimFfmpegSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridMunimFfmpegSpec() override = default;
+
+    public:
+      // Properties
+      virtual std::string getFfmpegVersion() = 0;
+
+    public:
+      // Methods
+      virtual std::shared_ptr<Promise<FFmpegSessionResult>> execute(const std::vector<std::string>& arguments_, const std::optional<std::function<void(const std::string& /* message */)>>& onLog, const std::optional<std::function<void(double /* timeMs */, double /* sizeBytes */, double /* bitrateKbits */, double /* speed */, double /* videoFrameNumber */, double /* fps */, double /* quality */)>>& onStatistics, const std::optional<std::function<void(double /* sessionId */)>>& onSessionCreated) = 0;
+      virtual std::shared_ptr<Promise<FFmpegSessionResult>> probe(const std::vector<std::string>& arguments_, const std::optional<std::function<void(const std::string& /* message */)>>& onLog, const std::optional<std::function<void(double /* sessionId */)>>& onSessionCreated) = 0;
+      virtual std::shared_ptr<Promise<std::string>> getMediaInformation(const std::string& path) = 0;
+      virtual void cancel(std::optional<double> sessionId) = 0;
+      virtual void cancelAll() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "MunimFfmpeg";
+  };
+
+} // namespace margelo::nitro::munimffmpeg

package/package.json

@@ -0,0 +1,131 @@
+{
+  "name": "munim-ffmpeg",
+  "version": "0.1.0",
+  "description": "Fast FFmpeg and FFprobe for Expo and React Native, powered by Nitro Modules",
+  "main": "lib/index",
+  "module": "lib/index",
+  "types": "lib/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "react-native.config.js",
+    "lib",
+    "nitrogen",
+    "android/build.gradle",
+    "android/gradle.properties",
+    "android/fix-prefab.gradle",
+    "android/CMakeLists.txt",
+    "android/src",
+    "cpp",
+    "ios/**/*.h",
+    "ios/**/*.m",
+    "ios/**/*.mm",
+    "ios/**/*.cpp",
+    "ios/**/*.swift",
+    "scripts",
+    "app.plugin.js",
+    "nitro.json",
+    "*.podspec",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf android/build node_modules/**/android/build lib",
+    "lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
+    "lint-ci": "eslint \"**/*.{js,ts,tsx}\" -f @jamesacarr/github-actions --max-warnings 0",
+    "build": "npm run typecheck && tsc",
+    "prepack": "npm run build",
+    "typescript": "tsc",
+    "codegen": "nitrogen --logLevel=\"debug\"",
+    "specs": "npm run codegen"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "ffmpeg",
+    "ffprobe",
+    "video",
+    "audio",
+    "ios",
+    "android",
+    "typescript",
+    "nitro",
+    "nitro-modules",
+    "munim-technologies"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/munimtechnologies/munim-ffmpeg.git"
+  },
+  "author": "sheehanmunim <support@munimtech.com> (https://github.com/sheehanmunim)",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/munimtechnologies/munim-ffmpeg/issues"
+  },
+  "homepage": "https://github.com/munimtechnologies/munim-ffmpeg#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "expo": {
+    "name": "munim-ffmpeg",
+    "platforms": [
+      "ios",
+      "android"
+    ]
+  },
+  "devDependencies": {
+    "@react-native/eslint-config": "0.85.3",
+    "@types/react": "^19.2.15",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "nitrogen": "0.36.5",
+    "prettier": "^3.8.3",
+    "react": "19.2.3",
+    "react-native": "0.86.2",
+    "react-native-nitro-modules": "^0.36.5",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": ">=0.36.5 <1"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "warn",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false,
+    "semi": false
+  }
+}

package/react-native.config.js

@@ -0,0 +1,16 @@
+// https://github.com/react-native-community/cli/blob/main/docs/dependencies.md
+
+module.exports = {
+  dependency: {
+    platforms: {
+      /**
+       * @type {import('@react-native-community/cli-types').IOSDependencyParams}
+       */
+      ios: {},
+      /**
+       * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
+       */
+      android: {},
+    },
+  },
+}

package/scripts/patch-ffmpegkit-level.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tempfile'
+
+pods_root = ENV.fetch('PODS_ROOT')
+build_products = ENV.fetch('PODS_CONFIGURATION_BUILD_DIR')
+source_root = File.join(pods_root, 'ffmpeg-kit-ios-https-alt', 'ffmpegkit.xcframework')
+
+# Patch only the two vendored slices and CocoaPods' selected build product. Nitro's
+# Swift/C++ bridge imports the selected header after this before-compile phase.
+headers = [
+  File.join(source_root, 'ios-arm64', 'ffmpegkit.framework', 'Headers', 'Level.h'),
+  File.join(source_root, 'ios-arm64_x86_64-simulator', 'ffmpegkit.framework', 'Headers', 'Level.h'),
+  File.join(
+    build_products,
+    'XCFrameworkIntermediates',
+    'ffmpeg-kit-ios-https-alt',
+    'ffmpegkit.framework',
+    'Headers',
+    'Level.h'
+  ),
+].select { |path| File.file?(path) }
+
+abort('munim-ffmpeg: could not find the expected FFmpegKit Level.h') if headers.empty?
+
+unsigned_declaration = 'NS_ENUM(NSUInteger, Level)'
+signed_declaration = 'NS_ENUM(NSInteger, Level)'
+
+headers.each do |header|
+  contents = File.binread(header)
+  next if contents.include?(signed_declaration) && !contents.include?(unsigned_declaration)
+
+  occurrences = contents.scan(unsigned_declaration).length
+  abort("munim-ffmpeg: unexpected Level enum declaration in #{header}") unless occurrences == 1
+
+  patched = contents.sub(unsigned_declaration, signed_declaration)
+  Tempfile.create(['Level', '.h'], File.dirname(header)) do |temporary|
+    temporary.binmode
+    temporary.write(patched)
+    temporary.flush
+    FileUtils.chmod(File.stat(header).mode, temporary.path)
+    FileUtils.mv(temporary.path, header)
+  end
+end

package/src/index.ts

@@ -0,0 +1,56 @@
+import { NitroModules } from 'react-native-nitro-modules'
+import type {
+  FFmpegLogCallback,
+  FFmpegSessionResult,
+  FFmpegSessionCreatedCallback,
+  FFmpegStatisticsCallback,
+  MunimFfmpeg as MunimFfmpegSpec,
+} from './specs/MunimFfmpeg.nitro'
+
+const MunimFfmpeg =
+  NitroModules.createHybridObject<MunimFfmpegSpec>('MunimFfmpeg')
+
+export type {
+  FFmpegLogCallback,
+  FFmpegSessionResult,
+  FFmpegSessionCreatedCallback,
+  FFmpegStatisticsCallback,
+  MunimFfmpegSpec,
+}
+
+export function execute(
+  arguments_: string[],
+  onLog?: FFmpegLogCallback,
+  onStatistics?: FFmpegStatisticsCallback,
+  onSessionCreated?: FFmpegSessionCreatedCallback
+): Promise<FFmpegSessionResult> {
+  return MunimFfmpeg.execute(arguments_, onLog, onStatistics, onSessionCreated)
+}
+
+export function probe(
+  arguments_: string[],
+  onLog?: FFmpegLogCallback,
+  onSessionCreated?: FFmpegSessionCreatedCallback
+): Promise<FFmpegSessionResult> {
+  return MunimFfmpeg.probe(arguments_, onLog, onSessionCreated)
+}
+
+export function getMediaInformation(path: string): Promise<unknown> {
+  return MunimFfmpeg.getMediaInformation(path).then((value) =>
+    JSON.parse(value)
+  )
+}
+
+export function cancel(sessionId?: number): void {
+  MunimFfmpeg.cancel(sessionId)
+}
+
+export function cancelAll(): void {
+  MunimFfmpeg.cancelAll()
+}
+
+export function getFFmpegVersion(): string {
+  return MunimFfmpeg.ffmpegVersion
+}
+
+export default MunimFfmpeg

package/src/specs/MunimFfmpeg.nitro.ts

@@ -0,0 +1,52 @@
+import type { HybridObject } from 'react-native-nitro-modules'
+
+export type FFmpegSessionResult = {
+  sessionId: number
+  returnCode: number
+  success: boolean
+  cancelled: boolean
+  state: string
+  durationMs: number
+  output: string
+  failStackTrace?: string
+}
+
+export type FFmpegLogCallback = (message: string) => void
+
+export type FFmpegSessionCreatedCallback = (sessionId: number) => void
+
+export type FFmpegStatisticsCallback = (
+  timeMs: number,
+  sizeBytes: number,
+  bitrateKbits: number,
+  speed: number,
+  videoFrameNumber: number,
+  fps: number,
+  quality: number
+) => void
+
+export interface MunimFfmpeg extends HybridObject<{
+  ios: 'swift'
+  android: 'kotlin'
+}> {
+  readonly ffmpegVersion: string
+
+  execute(
+    arguments_: string[],
+    onLog?: FFmpegLogCallback,
+    onStatistics?: FFmpegStatisticsCallback,
+    onSessionCreated?: FFmpegSessionCreatedCallback
+  ): Promise<FFmpegSessionResult>
+
+  probe(
+    arguments_: string[],
+    onLog?: FFmpegLogCallback,
+    onSessionCreated?: FFmpegSessionCreatedCallback
+  ): Promise<FFmpegSessionResult>
+
+  getMediaInformation(path: string): Promise<string>
+
+  cancel(sessionId?: number): void
+
+  cancelAll(): void
+}