expo-libvlc-player 0.1.0

package/build/VlcPlayerView.js

@@ -0,0 +1,36 @@
+import { requireNativeView } from "expo";
+import * as React from "react";
+import { convertNativeProps } from "./utils/props";
+const NativeView = requireNativeView("ExpoLibVlcPlayer");
+let loggedRenderingChildrenWarning = false;
+const VlcPlayerView = React.forwardRef((props, ref) => {
+    const nativeProps = convertNativeProps(props);
+    // @ts-expect-error
+    if (nativeProps.children && !loggedRenderingChildrenWarning) {
+        console.warn("The <VLCPlayerView> component does not support children. This may lead to inconsistent behaviour or crashes. If you want to render content on top of the VLCPlayer, consider using absolute positioning.");
+        loggedRenderingChildrenWarning = true;
+    }
+    const onWarn = ({ nativeEvent }) => {
+        if (props.onWarn) {
+            props.onWarn(nativeEvent);
+        }
+    };
+    const onError = ({ nativeEvent }) => {
+        if (props.onError) {
+            props.onError(nativeEvent);
+        }
+    };
+    const onPositionChanged = ({ nativeEvent, }) => {
+        if (props.onPositionChanged) {
+            props.onPositionChanged(nativeEvent);
+        }
+    };
+    const onLoad = ({ nativeEvent }) => {
+        if (props.onLoad) {
+            props.onLoad(nativeEvent);
+        }
+    };
+    return (<NativeView {...nativeProps} ref={ref} onWarn={onWarn} onError={onError} onPositionChanged={onPositionChanged} onLoad={onLoad}/>);
+});
+export default VlcPlayerView;
+//# sourceMappingURL=VlcPlayerView.js.map

package/build/VlcPlayerView.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VlcPlayerView.js","sourceRoot":"","sources":["../src/VlcPlayerView.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAW/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,MAAM,UAAU,GACd,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;AAExC,IAAI,8BAA8B,GAAG,KAAK,CAAC;AAE3C,MAAM,aAAa,GAAG,KAAK,CAAC,UAAU,CACpC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACb,MAAM,WAAW,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE9C,mBAAmB;IACnB,IAAI,WAAW,CAAC,QAAQ,IAAI,CAAC,8BAA8B,EAAE,CAAC;QAC5D,OAAO,CAAC,IAAI,CACV,0MAA0M,CAC3M,CAAC;QACF,8BAA8B,GAAG,IAAI,CAAC;IACxC,CAAC;IAED,MAAM,MAAM,GAAG,CAAC,EAAE,WAAW,EAAyB,EAAE,EAAE;QACxD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,EAAE,WAAW,EAA0B,EAAE,EAAE;QAC1D,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,EACzB,WAAW,GAGZ,EAAE,EAAE;QACH,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,EAAE,WAAW,EAA8B,EAAE,EAAE;QAC7D,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,CACL,CAAC,UAAU,CACT,IAAI,WAAW,CAAC,CAChB,GAAG,CAAC,CAAC,GAAG,CAAC,CACT,MAAM,CAAC,CAAC,MAAM,CAAC,CACf,OAAO,CAAC,CAAC,OAAO,CAAC,CACjB,iBAAiB,CAAC,CAAC,iBAAiB,CAAC,CACrC,MAAM,CAAC,CAAC,MAAM,CAAC,EACf,CACH,CAAC;AACJ,CAAC,CACF,CAAC;AAEF,eAAe,aAAa,CAAC","sourcesContent":["import { requireNativeView } from \"expo\";\nimport * as React from \"react\";\n\nimport {\n  VlcPlayerViewNativeProps,\n  VlcPlayerViewProps,\n  VLCPlayerViewRef,\n  type Warn,\n  type Error,\n  type PositionChanged,\n  type VideoInfo,\n} from \"./VlcPlayer.types\";\nimport { convertNativeProps } from \"./utils/props\";\n\nconst NativeView: React.ComponentType<VlcPlayerViewNativeProps> =\n  requireNativeView(\"ExpoLibVlcPlayer\");\n\nlet loggedRenderingChildrenWarning = false;\n\nconst VlcPlayerView = React.forwardRef<VLCPlayerViewRef, VlcPlayerViewProps>(\n  (props, ref) => {\n    const nativeProps = convertNativeProps(props);\n\n    // @ts-expect-error\n    if (nativeProps.children && !loggedRenderingChildrenWarning) {\n      console.warn(\n        \"The <VLCPlayerView> component does not support children. This may lead to inconsistent behaviour or crashes. If you want to render content on top of the VLCPlayer, consider using absolute positioning.\",\n      );\n      loggedRenderingChildrenWarning = true;\n    }\n\n    const onWarn = ({ nativeEvent }: { nativeEvent: Warn }) => {\n      if (props.onWarn) {\n        props.onWarn(nativeEvent);\n      }\n    };\n\n    const onError = ({ nativeEvent }: { nativeEvent: Error }) => {\n      if (props.onError) {\n        props.onError(nativeEvent);\n      }\n    };\n\n    const onPositionChanged = ({\n      nativeEvent,\n    }: {\n      nativeEvent: PositionChanged;\n    }) => {\n      if (props.onPositionChanged) {\n        props.onPositionChanged(nativeEvent);\n      }\n    };\n\n    const onLoad = ({ nativeEvent }: { nativeEvent: VideoInfo }) => {\n      if (props.onLoad) {\n        props.onLoad(nativeEvent);\n      }\n    };\n\n    return (\n      <NativeView\n        {...nativeProps}\n        ref={ref}\n        onWarn={onWarn}\n        onError={onError}\n        onPositionChanged={onPositionChanged}\n        onLoad={onLoad}\n      />\n    );\n  },\n);\n\nexport default VlcPlayerView;\n"]}

package/build/index.d.ts

@@ -0,0 +1,4 @@
+export { default } from "./VlcPlayerModule";
+export { default as VLCPlayerView } from "./VlcPlayerView";
+export * from "./VlcPlayer.types";
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,cAAc,mBAAmB,CAAC"}

package/build/index.js

@@ -0,0 +1,5 @@
+// Reexport the native module. On native platforms, it will be resolved to VlcPlayer.ts
+export { default } from "./VlcPlayerModule";
+export { default as VLCPlayerView } from "./VlcPlayerView";
+export * from "./VlcPlayer.types";
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,cAAc,mBAAmB,CAAC","sourcesContent":["// Reexport the native module. On native platforms, it will be resolved to VlcPlayer.ts\nexport { default } from \"./VlcPlayerModule\";\nexport { default as VLCPlayerView } from \"./VlcPlayerView\";\nexport * from \"./VlcPlayer.types\";\n"]}

package/build/utils/props.d.ts

@@ -0,0 +1,3 @@
+import { VlcPlayerViewNativeProps, VlcPlayerViewProps } from "../VlcPlayer.types";
+export declare function convertNativeProps(props?: VlcPlayerViewProps): VlcPlayerViewNativeProps;
+//# sourceMappingURL=props.d.ts.map

package/build/utils/props.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/utils/props.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,kBAAkB,EACnB,MAAM,oBAAoB,CAAC;AAE5B,wBAAgB,kBAAkB,CAChC,KAAK,CAAC,EAAE,kBAAkB,GACzB,wBAAwB,CAY1B"}

package/build/utils/props.js

@@ -0,0 +1,11 @@
+export function convertNativeProps(props) {
+    if (!props || typeof props !== "object") {
+        return {};
+    }
+    const nativeProps = {};
+    for (const [key, value] of Object.entries(props)) {
+        nativeProps[key] = value;
+    }
+    return nativeProps;
+}
+//# sourceMappingURL=props.js.map

package/build/utils/props.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.js","sourceRoot":"","sources":["../../src/utils/props.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,kBAAkB,CAChC,KAA0B;IAE1B,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAA6B,EAAE,CAAC;IAEjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,WAAW,CAAC,GAAqC,CAAC,GAAG,KAAK,CAAC;IAC7D,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["import {\n  VlcPlayerViewNativeProps,\n  VlcPlayerViewProps,\n} from \"../VlcPlayer.types\";\n\nexport function convertNativeProps(\n  props?: VlcPlayerViewProps,\n): VlcPlayerViewNativeProps {\n  if (!props || typeof props !== \"object\") {\n    return {};\n  }\n\n  const nativeProps: VlcPlayerViewNativeProps = {};\n\n  for (const [key, value] of Object.entries(props)) {\n    nativeProps[key as keyof VlcPlayerViewNativeProps] = value;\n  }\n\n  return nativeProps;\n}\n"]}

package/eslint.config.js

@@ -0,0 +1,50 @@
+const { fixupConfigRules } = require("@eslint/compat");
+const { FlatCompat } = require("@eslint/eslintrc");
+const js = require("@eslint/js");
+const { defineConfig, globalIgnores } = require("eslint/config");
+const globals = require("globals");
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+module.exports = defineConfig([
+  {
+    extends: [...fixupConfigRules(compat.extends("universe/native"))],
+    rules: {
+      "no-restricted-imports": [
+        "warn",
+        {
+          patterns: ["fbjs/*", "fbjs"],
+        },
+      ],
+    },
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        __DEV__: true,
+      },
+    },
+  },
+  {
+    files: ["**/__tests__/*"],
+  },
+  {
+    files: ["./*.config.js", "./.*rc.js"],
+    extends: [...fixupConfigRules(compat.extends("universe/node"))],
+  },
+  {
+    files: ["**/*.ts", "**/*.tsx", "**/*.d.ts"],
+    rules: {
+      "no-redeclare": "off",
+      "@typescript-eslint/no-redeclare": "off",
+      "no-unused-expressions": "off",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-expressions": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+    },
+  },
+  globalIgnores(["**/build"]),
+]);

package/expo-module.config.json

@@ -0,0 +1,16 @@
+{
+  "platforms": [
+    "apple",
+    "android"
+  ],
+  "apple": {
+    "modules": [
+      "VlcPlayerModule"
+    ]
+  },
+  "android": {
+    "modules": [
+      "expo.modules.libvlcplayer.VlcPlayerModule"
+    ]
+  }
+}

package/ios/Enums/AudioMixingMode.swift

@@ -0,0 +1,35 @@
+import CoreMedia
+import ExpoModulesCore
+
+enum AudioMixingMode: String, Enumerable {
+  case mixWithOthers
+  case duckOthers
+  case doNotMix
+  case auto
+
+  func priority() -> Int {
+    switch self {
+    case .doNotMix:
+      return 3
+    case .auto:
+      return 2
+    case .duckOthers:
+      return 1
+    case .mixWithOthers:
+      return 0
+    }
+  }
+
+  func toSessionCategoryOption() -> AVAudioSession.CategoryOptions? {
+    switch self {
+    case .duckOthers:
+      return .duckOthers
+    case .mixWithOthers:
+      return .mixWithOthers
+    case .doNotMix:
+      return nil
+    case .auto:
+      return nil
+    }
+  }
+}

package/ios/ExpoLibVlcPlayer.podspec

@@ -0,0 +1,29 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name           = 'ExpoLibVlcPlayer'
+  s.version        = package['version']
+  s.summary        = package['description']
+  s.description    = package['description']
+  s.license        = package['license']
+  s.author         = package['author']
+  s.homepage       = package['homepage']
+  s.platforms      = {
+    :ios => '15.1'
+  }
+  s.swift_version  = '5.4'
+  s.source         = { git: 'https://github.com/cornejobarraza/expo-libvlc-player' }
+  s.static_framework = true
+
+  s.dependency 'ExpoModulesCore'
+  s.dependency 'MobileVLCKit', '3.6.0'
+
+  # Swift/Objective-C compatibility
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES',
+  }
+
+  s.source_files = "**/*.{h,m,mm,swift,hpp,cpp}"
+end

package/ios/VlcPlayerManager.swift

@@ -0,0 +1,116 @@
+import AVFoundation
+import ExpoModulesCore
+import Foundation
+
+class VlcPlayerManager {
+  static var shared = VlcPlayerManager()
+
+  private static var managerQueue = DispatchQueue(label: "com.expo.libvlcplayer.manager.managerQueue")
+  private var views = NSHashTable<VlcPlayerView>.weakObjects()
+
+  func registerView(view: VlcPlayerView) {
+    views.add(view)
+  }
+
+  func unregisterView(view: VlcPlayerView) {
+    views.remove(view)
+  }
+
+  func onAppDestroyed() {
+    for view in views.allObjects {
+      view.destroyPlayer()
+    }
+  }
+
+  func onAppBackgrounded() {
+    for view in views.allObjects {
+      view.onBackground([:])
+
+      guard let player = view.mediaPlayer else { continue }
+
+      if !view.playInBackground, player.isPlaying {
+        player.pause()
+      }
+    }
+  }
+
+  func setAppropriateAudioSessionOrWarn() {
+    Self.managerQueue.async { [weak self] in
+      self?.setAudioSession()
+    }
+  }
+
+  private func setAudioSession() {
+    let audioSession = AVAudioSession.sharedInstance()
+    let audioMixingMode = findAudioMixingMode()
+    var audioSessionCategoryOptions: AVAudioSession.CategoryOptions = audioSession.categoryOptions
+
+    let isOutputtingAudio = views.allObjects.contains { view in
+      if let isPlaying = view.mediaPlayer?.isPlaying,
+         let isMuted = view.mediaPlayer?.audio?.isMuted
+      {
+        if isPlaying, !isMuted {
+          return true
+        }
+      }
+
+      return false
+    }
+
+    let shouldMixOverride = audioMixingMode == .mixWithOthers
+    let doNotMixOverride = audioMixingMode == .doNotMix
+    let shouldDuckOthers = audioMixingMode == .duckOthers && isOutputtingAudio
+
+    let shouldMixWithOthers = shouldMixOverride || !isOutputtingAudio
+
+    if shouldMixWithOthers && !shouldDuckOthers && !doNotMixOverride {
+      audioSessionCategoryOptions.insert(.mixWithOthers)
+    } else {
+      audioSessionCategoryOptions.remove(.mixWithOthers)
+    }
+
+    if shouldDuckOthers && !doNotMixOverride {
+      audioSessionCategoryOptions.insert(.duckOthers)
+    } else {
+      audioSessionCategoryOptions.remove(.duckOthers)
+    }
+
+    if audioSession.categoryOptions != audioSessionCategoryOptions || audioSession.category != .playback || audioSession.mode != .moviePlayback {
+      do {
+        try audioSession.setCategory(.playback, mode: .moviePlayback, options: audioSessionCategoryOptions)
+      } catch {
+        log.warn("Failed to set audio session category")
+      }
+    }
+
+    if isOutputtingAudio || doNotMixOverride {
+      do {
+        try audioSession.setActive(true)
+      } catch {
+        log.warn("Failed to activate the audio session")
+      }
+    }
+  }
+
+  private func findAudioMixingMode() -> AudioMixingMode? {
+    let playingViews = views.allObjects.filter { view in
+      if let isPlaying = view.mediaPlayer?.isPlaying, isPlaying {
+        return true
+      }
+
+      return false
+    }
+
+    var audioMixingMode: AudioMixingMode = .mixWithOthers
+
+    if playingViews.isEmpty {
+      return nil
+    }
+
+    for playerView in playingViews where (audioMixingMode.priority()) < playerView.audioMixingMode.priority() {
+      audioMixingMode = playerView.audioMixingMode
+    }
+
+    return audioMixingMode
+  }
+}

package/ios/VlcPlayerModule.swift

@@ -0,0 +1,110 @@
+import AVFoundation
+import ExpoModulesCore
+
+private let bufferingEvent = "onBuffering"
+private let playingEvent = "onPlaying"
+private let pausedEvent = "onPaused"
+private let stoppedEvent = "onStopped"
+private let endedEvent = "onEnded"
+private let repeatEvent = "onRepeat"
+private let warnEvent = "onWarn"
+private let errorEvent = "onError"
+private let positionChangedEvent = "onPositionChanged"
+private let loadEvent = "onLoad"
+private let backgroundEvent = "onBackground"
+
+let playerEvents = [
+    bufferingEvent,
+    playingEvent,
+    pausedEvent,
+    stoppedEvent,
+    endedEvent,
+    repeatEvent,
+    warnEvent,
+    errorEvent,
+    positionChangedEvent,
+    loadEvent,
+    backgroundEvent,
+]
+
+public class VlcPlayerModule: Module {
+    public func definition() -> ModuleDefinition {
+        Name("ExpoLibVlcPlayer")
+
+        OnDestroy {
+            VlcPlayerManager.shared.onAppDestroyed()
+        }
+
+        View(VlcPlayerView.self) {
+            Events(playerEvents)
+
+            Prop("uri") { (view: VlcPlayerView, uri: String) in
+                view.setUri(uri)
+            }
+
+            Prop("subtitle") { (view: VlcPlayerView, subtitle: [String: Any]?) in
+                view.setSubtitle(subtitle)
+            }
+
+            Prop("options") { (view: VlcPlayerView, options: [String]?) in
+                view.setOptions(options ?? [String]())
+            }
+
+            Prop("volume") { (view: VlcPlayerView, volume: Int?) in
+                view.setVolume(volume ?? maxPlayerVolume)
+            }
+
+            Prop("mute") { (view: VlcPlayerView, mute: Bool?) in
+                view.setMute(mute ?? false)
+            }
+
+            Prop("rate") { (view: VlcPlayerView, rate: Float?) in
+                view.setRate(rate ?? defaultPlayerRate)
+            }
+
+            Prop("tracks") { (view: VlcPlayerView, tracks: [String: Any]?) in
+                view.setTracks(tracks)
+            }
+
+            Prop("repeat") { (view: VlcPlayerView, shouldRepeat: Bool?) in
+                view.setRepeat(shouldRepeat ?? false)
+            }
+
+            Prop("aspectRatio") { (view: VlcPlayerView, aspectRatio: String?) in
+                view.setAspectRatio(aspectRatio)
+            }
+
+            Prop("audioMixingMode") { (view: VlcPlayerView, audioMixingMode: AudioMixingMode) in
+                view.setAudioMixingMode(audioMixingMode)
+            }
+
+            Prop("playInBackground") { (view: VlcPlayerView, playInBackground: Bool?) in
+                view.setPlayInBackground(playInBackground ?? false)
+            }
+
+            Prop("autoplay") { (view: VlcPlayerView, autoplay: Bool?) in
+                view.setAutoplay(autoplay ?? true)
+            }
+
+            AsyncFunction("play") { (view: VlcPlayerView) in
+                view.play()
+            }
+
+            AsyncFunction("pause") { (view: VlcPlayerView) in
+                view.pause()
+            }
+
+            AsyncFunction("stop") { (view: VlcPlayerView) in
+                view.stop()
+            }
+
+            AsyncFunction("seek") { (view: VlcPlayerView, position: Float) in
+                view.seek(position)
+            }
+        }
+
+        OnAppEntersBackground {
+            VlcPlayerManager.shared.onAppBackgrounded()
+        }
+    }
+}