@npaw/forge-react-native-video 9.6.1

package/LICENSE

@@ -0,0 +1,10 @@
+Copyright (C) NPAW - All Rights Reserved
+
+This software is protected under international copyright law. All rights
+reserved and protected by the copyright holders. This software is confidential
+and only available to authorized individuals with the permission of the
+copyright holders. If you obtained this software and do not have permission,
+please contact the copyright holders and delete it.
+
+Use of this software requires an active NPAW commercial agreement. See
+https://npaw.com for licensing and support.

package/NPAWForgeReactNativeVideo.podspec

@@ -0,0 +1,48 @@
+# Copyright (C) NPAW - All Rights Reserved
+#
+# This source code is protected under international copyright law. All rights
+# reserved and protected by the copyright holders. This file is confidential and
+# only available to authorized individuals with the permission of the copyright
+# holders. If you encounter this file and do not have permission, please contact
+# the copyright holders and delete this file.
+#
+#
+# @author: Victor Soto <victor.soto@nicepeopleatwork.com>
+# @description: CocoaPods spec for the @npaw/forge-react-native-video glue (Forge AVPlayerAdapter onto react-native-video's plugin API).
+
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "NPAWForgeReactNativeVideo"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = "https://npaw.com"
+  s.license      = { :type => "Commercial", :text => "Copyright (C) NPAW - All Rights Reserved" }
+  s.authors      = { "Victor Soto" => "victor.soto@nicepeopleatwork.com" }
+  s.platforms    = { :ios => "13.0" }
+  s.source       = { :path => "." }
+
+  s.source_files  = "ios/**/*.{h,m,mm,swift}"
+  s.swift_version = "5.9"
+  s.pod_target_xcconfig = {
+    "DEFINES_MODULE" => "YES",
+  }
+
+  s.dependency "NPAWForgeReactNative"
+  s.dependency "react-native-video"
+
+  # FORGE_APPLE_CONSUMPTION BEGIN (staged: ForgeApple ships inside the core pod)
+  s.pod_target_xcconfig = {
+    "DEFINES_MODULE" => "YES",
+    "OTHER_SWIFT_FLAGS" => "$(inherited) -DFORGE_RN_HYDRATED",
+  }
+  # FORGE_APPLE_CONSUMPTION END
+
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency "React-Core"
+  end
+end

package/README.md

@@ -0,0 +1,41 @@
+# @npaw/forge-react-native-video
+
+`react-native-video` player adapter for NPAW Forge: automatic playback and QoS
+reporting by attaching to the player instance `react-native-video` already
+manages.
+
+Use of this package requires an active NPAW commercial agreement. See
+[LICENSE](./LICENSE).
+
+## Install
+
+```sh
+npm install @npaw/forge-react-native @npaw/forge-react-native-video
+```
+
+Requires `react-native-video` v6 and React Native 0.75+ with the New
+Architecture enabled.
+
+### iOS
+
+```sh
+cd ios && pod install
+```
+
+## Usage
+
+Register the adapter alongside your `Video` component; the adapter attaches to
+the underlying player and reports playback to the Forge session created with
+[`@npaw/forge-react-native`](https://www.npmjs.com/package/@npaw/forge-react-native).
+
+```js
+import { NPAWForge } from '@npaw/forge-react-native';
+import { attachForgeVideo } from '@npaw/forge-react-native-video';
+
+const video = await attachForgeVideo(forge, { identifier: 'main' });
+```
+
+## Documentation
+
+Integration guides and the API reference are published at
+[npaw.com](https://npaw.com).

package/android/build.gradle

@@ -0,0 +1,98 @@
+// Copyright (C) NPAW - All Rights Reserved
+//
+// This source code is protected under international copyright law. All rights
+// reserved and protected by the copyright holders. This file is confidential and
+// only available to authorized individuals with the permission of the copyright
+// holders. If you encounter this file and do not have permission, please contact
+// the copyright holders and delete this file.
+//
+//
+// @author: Victor Soto <victor.soto@nicepeopleatwork.com>
+// @description: Android library build for the @npaw/forge-react-native-video glue module (Forge Media3 adapter onto react-native-video's plugin API). Pure-Java module so it builds under any host-app Kotlin version.
+
+def isNewArchitectureEnabled() {
+    return project.hasProperty('newArchEnabled') && project.newArchEnabled == 'true'
+}
+
+apply plugin: 'com.android.library'
+if (isNewArchitectureEnabled()) {
+    apply plugin: 'com.facebook.react'
+}
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+def forgeCoreVersion = project.hasProperty('NpawForge_forgeCoreVersion')
+    ? project.property('NpawForge_forgeCoreVersion')
+    : (System.getenv('FORGE_CORE_VERSION') ?: '9.6.1')
+
+def forgeAdapterVersion = project.hasProperty('NpawForge_forgeAdapterVersion')
+    ? project.property('NpawForge_forgeAdapterVersion')
+    : (System.getenv('FORGE_ADAPTER_VERSION') ?: '9.6.1')
+
+android {
+    namespace 'com.npaw.forge.reactnative.video'
+    compileSdkVersion safeExtGet('compileSdkVersion', 35)
+
+    defaultConfig {
+        minSdkVersion safeExtGet('minSdkVersion', 23)
+        targetSdkVersion safeExtGet('targetSdkVersion', 34)
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    testOptions {
+        unitTests.returnDefaultValues = true
+    }
+}
+
+repositories {
+    mavenCentral()
+    google()
+    def localMavenRepo = System.getenv('FORGE_LOCAL_MAVEN_REPO')
+    if (localMavenRepo != null && !localMavenRepo.isEmpty()) {
+        maven { url uri(localMavenRepo) }
+    }
+    maven { url 'https://artifact.plugin.npaw.com/artifactory/plugins/android' }
+}
+
+// The core RN library project name comes from React Native autolinking's
+// package-name sanitization; probe the known spellings so this module works
+// wherever the app's settings.gradle placed it.
+def forgeCoreRnProject = [
+    ':npaw_forge-react-native',
+    ':forge-react-native',
+    ':npaw-forge-react-native',
+].collect { findProject(it) }.find { it != null }
+
+def reactNativeVideoProject = findProject(':react-native-video')
+
+// The Forge media3 adapter declares its player SDK compileOnly (runtime
+// player detection), and react-native-video provides media3 at the app level;
+// this module needs the same media3 surface on its own compile classpath.
+def media3Version = safeExtGet('media3Version', '1.8.0')
+
+dependencies {
+    implementation 'com.facebook.react:react-native:+'
+    // compileOnly + runtimeOnly split — see the core module's build.gradle:
+    // keeps the Kotlin-2.3 Forge graph off host-app Kotlin compile classpaths.
+    compileOnly "com.npaw.forge:forge-android-core:${forgeCoreVersion}"
+    runtimeOnly "com.npaw.forge:forge-android-core:${forgeCoreVersion}"
+    compileOnly "com.npaw.forge:forge-adapter-media3:${forgeAdapterVersion}"
+    runtimeOnly "com.npaw.forge:forge-adapter-media3:${forgeAdapterVersion}"
+    compileOnly "androidx.media3:media3-common:${media3Version}"
+    compileOnly "androidx.media3:media3-datasource:${media3Version}"
+    compileOnly "androidx.media3:media3-exoplayer:${media3Version}"
+    if (forgeCoreRnProject != null) {
+        implementation forgeCoreRnProject
+    }
+    if (reactNativeVideoProject != null) {
+        compileOnly reactNativeVideoProject
+    }
+
+    testImplementation 'junit:junit:4.13.2'
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Copyright (C) NPAW - All Rights Reserved
+
+  This source code is protected under international copyright law. All rights
+  reserved and protected by the copyright holders. This file is confidential and
+  only available to authorized individuals with the permission of the copyright
+  holders. If you encounter this file and do not have permission, please contact
+  the copyright holders and delete this file.
+
+  @author: Victor Soto <victor.soto@nicepeopleatwork.com>
+  @description: Manifest stub for the @npaw/forge-react-native-video Android library module.
+-->
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" />

package/android/src/main/java/com/npaw/forge/reactnative/video/NPAWForgeVideoModule.java

@@ -0,0 +1,341 @@
+/**
+ * Copyright (C) NPAW - All Rights Reserved
+ *
+ * This source code is protected under international copyright law. All rights
+ * reserved and protected by the copyright holders.
+ * This file is confidential and only available to authorized individuals with the
+ * permission of the copyright holders. If you encounter this file and do not have
+ * permission, please contact the copyright holders and delete this file.
+ *
+ *
+ * @author: Victor Soto <victor.soto@nicepeopleatwork.com>
+ * @description: react-native-video glue TurboModule for Android. Implements RNVExoplayerPlugin, smuggles the X-NPAW-Forge header token into the MediaItem tag via overrideMediaItemBuilder, caches player facts on the main thread, and delegates policy to RNVideoAttachCoordinator to bind Forge's Media3PlayerAdapter.
+ */
+
+package com.npaw.forge.reactnative.video;
+
+import androidx.annotation.Nullable;
+import android.os.Handler;
+import android.os.Looper;
+import androidx.media3.common.MediaItem;
+import androidx.media3.datasource.DataSource;
+import androidx.media3.exoplayer.ExoPlayer;
+import androidx.media3.exoplayer.drm.DrmSessionManager;
+import androidx.media3.exoplayer.source.MediaSource;
+import com.brentvatne.common.api.Source;
+import com.brentvatne.exoplayer.DRMManagerSpec;
+import com.brentvatne.exoplayer.RNVExoplayerPlugin;
+import com.brentvatne.react.ReactNativeVideoManager;
+import com.facebook.react.bridge.Arguments;
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.bridge.UiThreadUtil;
+import com.facebook.react.bridge.WritableMap;
+import com.npaw.forge.android.NPAWForge;
+import com.npaw.forge.android.adapters.media3.Media3PlayerAdapter;
+import com.npaw.forge.android.video.VideoAdapter;
+import com.npaw.forge.reactnative.ForgeInstanceRegistry;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+public class NPAWForgeVideoModule extends NativeNPAWForgeVideoSpec
+    implements RNVExoplayerPlugin {
+
+  public static final String NAME = "NPAWForgeVideoRN";
+  /** Header customers set on source.requestHeaders for multi-player matching. */
+  public static final String TOKEN_HEADER = "x-npaw-forge";
+  private static final String TAG_PREFIX = "npaw-forge:";
+  private static final String E_UNKNOWN_INSTANCE = "E_FORGE_UNKNOWN_INSTANCE";
+
+  private static final class PlayerFacts {
+    @Nullable volatile String token;
+    @Nullable volatile String uri;
+  }
+
+  private final ConcurrentHashMap<String, PlayerFacts> facts = new ConcurrentHashMap<>();
+  private final ConcurrentHashMap<String, ExoPlayer> playersById = new ConcurrentHashMap<>();
+  private final ConcurrentHashMap<String, Media3PlayerAdapter> adaptersByPlayerId =
+      new ConcurrentHashMap<>();
+  private final Handler mainHandler = new Handler(Looper.getMainLooper());
+
+  private final RNVideoAttachCoordinator<ExoPlayer> coordinator =
+      new RNVideoAttachCoordinator<>(
+          new RNVideoAttachCoordinator.PlayerIntrospection() {
+            @Nullable
+            @Override
+            public String currentToken(String playerId) {
+              PlayerFacts f = facts.get(playerId);
+              return f == null ? null : f.token;
+            }
+
+            @Nullable
+            @Override
+            public String currentUri(String playerId) {
+              PlayerFacts f = facts.get(playerId);
+              return f == null ? null : f.uri;
+            }
+          },
+          new RNVideoAttachCoordinator.Binder<ExoPlayer>() {
+            @Override
+            public void bind(String instanceId, String identifier, String playerId, ExoPlayer player) {
+              bindOnMain(instanceId, identifier, playerId, player);
+            }
+
+            @Override
+            public void unbind(
+                String instanceId, String identifier, String playerId, boolean fireStop) {
+              unbindOnMain(instanceId, identifier, playerId, fireStop);
+            }
+          });
+
+  public NPAWForgeVideoModule(ReactApplicationContext reactContext) {
+    super(reactContext);
+    ReactNativeVideoManager.Companion.getInstance().registerPlugin(this);
+  }
+
+  @Override
+  public String getName() {
+    return NAME;
+  }
+
+  // ---- spec surface ----
+
+  @Override
+  public void attach(String instanceId, String identifier, @Nullable ReadableMap options, Promise promise) {
+    NPAWForge forge = ForgeInstanceRegistry.resolve(instanceId);
+    if (forge == null) {
+      promise.reject(E_UNKNOWN_INSTANCE, "No NPAWForge instance '" + instanceId + "'");
+      return;
+    }
+    ensureVideo(forge, identifier);
+
+    Map<String, Object> map = options == null ? new HashMap<>() : options.toHashMap();
+    String headerToken = stringOrNull(map.get("headerToken"));
+    String sourceUri = stringOrNull(map.get("sourceUri"));
+    String policy = stringOrNull(map.get("policy"));
+    if (policy == null) {
+      policy = (headerToken != null || sourceUri != null) ? "match" : "auto";
+    }
+    boolean stopOnPlayerRemoved =
+        !(map.get("stopOnPlayerRemoved") instanceof Boolean)
+            || (Boolean) map.get("stopOnPlayerRemoved");
+
+    RNVideoAttachCoordinator.AttachOutcome outcome =
+        coordinator.attach(
+            new RNVideoAttachCoordinator.AttachRequest(
+                instanceId, identifier, policy, headerToken, sourceUri, stopOnPlayerRemoved));
+    scheduleFactRefreshes();
+    promise.resolve(attachResult(outcome));
+  }
+
+  @Override
+  public void detach(String instanceId, String identifier, Promise promise) {
+    boolean removed = coordinator.detach(instanceId, identifier, true);
+    WritableMap result = Arguments.createMap();
+    result.putString("code", removed ? "accepted" : "ignored_invalid_state");
+    result.putBoolean("isAccepted", removed);
+    result.putString("attachment", "pending");
+    promise.resolve(result);
+  }
+
+  @Override
+  public void invalidate() {
+    ReactNativeVideoManager.Companion.getInstance().unregisterPlugin(this);
+    coordinator.clear();
+    facts.clear();
+    playersById.clear();
+    adaptersByPlayerId.clear();
+    super.invalidate();
+  }
+
+  // ---- RNVExoplayerPlugin ----
+
+  @Override
+  public void onInstanceCreated(String id, ExoPlayer player) {
+    facts.putIfAbsent(id, new PlayerFacts());
+    playersById.put(id, player);
+    UiThreadUtil.runOnUiThread(
+        () -> {
+          refreshFacts(id, player);
+          coordinator.playerCreated(id, player);
+        });
+    scheduleFactRefreshes();
+  }
+
+  @Override
+  public void onInstanceRemoved(String id, ExoPlayer player) {
+    playersById.remove(id);
+    facts.remove(id);
+    coordinator.playerRemoved(id);
+  }
+
+  // ---- RNVExoplayerPlugin optional hooks ----
+
+  @Nullable
+  @Override
+  public DRMManagerSpec getDRMManager() {
+    return null;
+  }
+
+  @Nullable
+  @Override
+  public DrmSessionManager overrideDrmSessionManager(Source source, DrmSessionManager drmSessionManager) {
+    return null;
+  }
+
+  @Nullable
+  @Override
+  public DataSource.Factory overrideMediaDataSourceFactory(
+      Source source, DataSource.Factory mediaDataSourceFactory) {
+    return null;
+  }
+
+  @Nullable
+  @Override
+  public MediaSource.Factory overrideMediaSourceFactory(
+      Source source, MediaSource.Factory mediaSourceFactory, DataSource.Factory mediaDataSourceFactory) {
+    return null;
+  }
+
+  @Nullable
+  @Override
+  public MediaItem.Builder overrideMediaItemBuilder(Source source, MediaItem.Builder mediaItemBuilder) {
+    String token = tokenFromHeaders(source.getHeaders());
+    if (token == null) {
+      return null;
+    }
+    // The tag rides the MediaItem so introspection can read it back from
+    // player.currentMediaItem on the main thread - deterministic multi-player
+    // correlation without joining override->create call ordering.
+    return mediaItemBuilder.setTag(TAG_PREFIX + token);
+  }
+
+  @Override
+  public boolean shouldDisableCache(Source source) {
+    return false;
+  }
+
+  @Override
+  public void onInstanceCreated(String id, Object player) {
+    if (player instanceof ExoPlayer) {
+      onInstanceCreated(id, (ExoPlayer) player);
+    }
+  }
+
+  @Override
+  public void onInstanceRemoved(String id, Object player) {
+    if (player instanceof ExoPlayer) {
+      onInstanceRemoved(id, (ExoPlayer) player);
+    }
+  }
+
+  // ---- internals ----
+
+  private void ensureVideo(NPAWForge forge, String identifier) {
+    if (forge.getVideoAdapter(identifier) == null) {
+      forge.videoBuilder().setIdentifier(identifier).build();
+    }
+  }
+
+  /**
+   * Sources settle after player creation; instead of a media3 Player.Listener
+   * (whose default-method desugaring is fragile across media3 versions), a
+   * few delayed main-thread refreshes converge token/URI facts and re-run the
+   * pending-match evaluation.
+   */
+  private void scheduleFactRefreshes() {
+    for (long delayMs : new long[] {0L, 500L, 1500L, 3000L}) {
+      mainHandler.postDelayed(
+          () -> {
+            for (Map.Entry<String, ExoPlayer> entry : playersById.entrySet()) {
+              refreshFacts(entry.getKey(), entry.getValue());
+            }
+            coordinator.playerSourceSettled();
+          },
+          delayMs);
+    }
+  }
+
+  /** Main thread only. */
+  private void refreshFacts(String playerId, ExoPlayer player) {
+    PlayerFacts f = facts.computeIfAbsent(playerId, key -> new PlayerFacts());
+    MediaItem item = player.getCurrentMediaItem();
+    if (item != null && item.localConfiguration != null) {
+      Object tag = item.localConfiguration.tag;
+      f.token =
+          tag instanceof String && ((String) tag).startsWith(TAG_PREFIX)
+              ? ((String) tag).substring(TAG_PREFIX.length())
+              : null;
+      f.uri = item.localConfiguration.uri.toString();
+    }
+  }
+
+  private void bindOnMain(String instanceId, String identifier, String playerId, ExoPlayer player) {
+    UiThreadUtil.runOnUiThread(
+        () -> {
+          NPAWForge forge = ForgeInstanceRegistry.resolve(instanceId);
+          if (forge == null || player == null) {
+            return;
+          }
+          ensureVideo(forge, identifier);
+          VideoAdapter video = forge.getVideoAdapter(identifier);
+          if (video == null) {
+            return;
+          }
+          Media3PlayerAdapter adapter = new Media3PlayerAdapter(player);
+          video.setPlayerAdapter(adapter);
+          adaptersByPlayerId.put(playerId, adapter);
+        });
+  }
+
+  private void unbindOnMain(String instanceId, String identifier, String playerId, boolean fireStop) {
+    UiThreadUtil.runOnUiThread(
+        () -> {
+          adaptersByPlayerId.remove(playerId);
+          VideoAdapter video = ForgeInstanceRegistry.resolveVideoAdapter(instanceId, identifier);
+          if (video == null) {
+            return;
+          }
+          if (fireStop) {
+            video.fireStop();
+          }
+          video.setPlayerAdapter(null);
+        });
+  }
+
+  @Nullable
+  private static String tokenFromHeaders(@Nullable Map<String, String> headers) {
+    if (headers == null) {
+      return null;
+    }
+    for (Map.Entry<String, String> entry : headers.entrySet()) {
+      if (entry.getKey() != null
+          && TOKEN_HEADER.equals(entry.getKey().toLowerCase(Locale.ROOT))) {
+        return entry.getValue();
+      }
+    }
+    return null;
+  }
+
+  @Nullable
+  private static String stringOrNull(@Nullable Object value) {
+    if (value instanceof String && !((String) value).isEmpty()) {
+      return (String) value;
+    }
+    return null;
+  }
+
+  private static WritableMap attachResult(RNVideoAttachCoordinator.AttachOutcome outcome) {
+    WritableMap result = Arguments.createMap();
+    result.putString("code", outcome.code);
+    result.putBoolean("isAccepted", outcome.accepted);
+    result.putString("attachment", outcome.attachment);
+    if (outcome.reason != null) {
+      result.putString("reason", outcome.reason);
+    }
+    return result;
+  }
+}

package/android/src/main/java/com/npaw/forge/reactnative/video/NPAWForgeVideoPackage.java

@@ -0,0 +1,53 @@
+/**
+ * Copyright (C) NPAW - All Rights Reserved
+ *
+ * This source code is protected under international copyright law. All rights
+ * reserved and protected by the copyright holders.
+ * This file is confidential and only available to authorized individuals with the
+ * permission of the copyright holders. If you encounter this file and do not have
+ * permission, please contact the copyright holders and delete this file.
+ *
+ *
+ * @author: Victor Soto <victor.soto@nicepeopleatwork.com>
+ * @description: React package registering the NPAWForgeVideo TurboModule for autolinking.
+ */
+
+package com.npaw.forge.reactnative.video;
+
+import com.facebook.react.TurboReactPackage;
+import com.facebook.react.bridge.NativeModule;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.module.model.ReactModuleInfo;
+import com.facebook.react.module.model.ReactModuleInfoProvider;
+import java.util.HashMap;
+import java.util.Map;
+import androidx.annotation.Nullable;
+
+public class NPAWForgeVideoPackage extends TurboReactPackage {
+
+  @Nullable
+  @Override
+  public NativeModule getModule(String name, ReactApplicationContext reactContext) {
+    if (NPAWForgeVideoModule.NAME.equals(name)) {
+      return new NPAWForgeVideoModule(reactContext);
+    }
+    return null;
+  }
+
+  @Override
+  public ReactModuleInfoProvider getReactModuleInfoProvider() {
+    return () -> {
+      Map<String, ReactModuleInfo> modules = new HashMap<>();
+      modules.put(
+          NPAWForgeVideoModule.NAME,
+          new ReactModuleInfo(
+              NPAWForgeVideoModule.NAME,
+              NPAWForgeVideoModule.class.getName(),
+              false,
+              false,
+              false,
+              true));
+      return modules;
+    };
+  }
+}