@gcorevideo/player 2.10.0 → 2.12.2

package/src/types.ts

@@ -1,3 +1,5 @@
+import { ContainerPlugin, CorePlugin } from "@clappr/core"
+
 /**
  * Describes a media source with its MIME type and URL.
  *
@@ -44,7 +46,7 @@ export type PlaybackType = 'live' | 'vod'
 /**
  * @beta
  */
-export type MediaTransport = 'dash' | 'hls' | 'mpegts'
+export type MediaTransport = 'dash' | 'hls'
 
 /**
  * @beta
@@ -57,7 +59,7 @@ export type TransportPreference = MediaTransport | 'auto'
  */
 export type PlayerPlugin = {
   new (...args: any[]): unknown
-  type: 'core' | 'container'
+  name: string
 }
 
 /**
@@ -161,7 +163,7 @@ export interface PlayerConfig extends Record<string, unknown> {
   /**
    * Localization strings for the player UI.
    */
-  strings: TranslationSettings
+  strings?: TranslationSettings
 }
 
 /**

package/src/typings/@clappr/core/error_mixin.d.ts

@@ -1,7 +1,5 @@
 import '@clappr/core';
-// import ErrorMixin from "@clappr/core/src/base/error_mixin/error_mixin";
 
-// export as namespace "@clappr/core";
 declare module "@clappr/core" {
     // export ErrorMixin;
 

package/src/typings/@clappr/core/index.d.ts

@@ -0,0 +1,5 @@
+import '@clappr/core'
+
+declare module '@clappr/core' {
+    
+}

package/src/typings/@clappr/index.d.ts

@@ -0,0 +1 @@
+declare module '@clappr' {}

package/src/utils/__tests__/mediaSources.test.ts

@@ -0,0 +1,230 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+
+import { isDashSource, isHlsSource, buildMediaSourcesList } from '../mediaSources'
+import { TransportPreference } from '../../types'
+import { canPlayDash, canPlayHls } from '../../playback/index'
+
+vi.mock('../../playback/index.js', () => ({
+  canPlayDash: vi.fn(),
+  canPlayHls: vi.fn(),
+}))
+
+beforeEach(() => {
+  vi.mocked(canPlayDash).mockImplementation(isDashSource)
+  vi.mocked(canPlayHls).mockImplementation(isHlsSource)
+})
+
+describe('mediaSources', () => {
+  describe('buildMediaSourcesList', () => {
+    describe.each([
+      [
+        'dash',
+        true,
+        true,
+        [
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+        [
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+      ],
+      [
+        'auto',
+        true,
+        true,
+        [
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+        [
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+      ],
+      [
+        'hls',
+        true,
+        true,
+        [
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+        [
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+        ],
+      ],
+      [
+        'dash',
+        false,
+        true,
+        [
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+        [
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+      ],
+      [
+        'hls',
+        true,
+        false,
+        [
+          {
+            source: 'http://example.com/video.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video3.m3u8',
+            mimeType: 'application/vnd.apple.mpegurl',
+          },
+        ],
+        [
+          {
+            source: 'http://example.com/video.mpd',
+            mimeType: 'application/dash+xml',
+          },
+          {
+            source: 'http://example.com/video2.mpd',
+            mimeType: 'application/dash+xml',
+          },
+        ],
+      ],
+    ])('prefer %s, dash=%s,hls=%s', (preference, dash, hls, sources, expected) => {
+      beforeEach(() => {
+        if (!dash) {
+          vi.mocked(canPlayDash).mockReturnValue(false)
+        }
+        if (!hls) {
+          vi.mocked(canPlayHls).mockReturnValue(false)
+        }
+      })
+      // afterEach(() => {
+      //   vi.mocked(canPlayDash)
+      // })
+      it('should build the ordered list of available sources', () => {
+        const ordered = buildMediaSourcesList(
+          sources,
+          preference as TransportPreference,
+        )
+        expect(ordered).toEqual(expect.objectContaining(expected))
+      })
+    })
+  })
+})

package/src/utils/mediaSources.ts

@@ -1,90 +1,104 @@
-import DashPlayback from '../plugins/dash-playback/DashPlayback'
-import HlsPlayback from '../plugins/hls-playback/HlsPlayback'
-import type { PlayerMediaSource, TransportPreference } from '../types'
+import type {
+  PlayerMediaSource,
+  PlayerMediaSourceDesc,
+  TransportPreference,
+} from '../types'
+import { canPlayDash, canPlayHls } from '../playback/index.js'
 
 export type SourceVariants = {
-  dash: string | null
-  master: string | null
-  hls: string | null
-  mpegts: string | null
+  dash: PlayerMediaSourceDesc | null
+  hls: PlayerMediaSourceDesc | null
+  mpegts: PlayerMediaSourceDesc | null
 }
 
+/**
+ *
+ * @param sources
+ * @deprecated
+ * @returns
+ */
 export function buildSourcesSet(sources: PlayerMediaSource[]): SourceVariants {
   const sv: SourceVariants = {
     dash: null,
-    master: null,
     hls: null,
     mpegts: null,
   }
   sources.forEach((ps) => {
-    const [s, t] = typeof ps === 'string' ? [ps, ''] : [ps.source, ps.mimeType]
-    if (DashPlayback.canPlay(s, t)) {
-      sv.dash = s
-    } else if (HlsPlayback.canPlay(s, t)) {
-      sv.hls = s
+    const ws = wrapSource(ps)
+    if (canPlayDash(ws.source, ws.mimeType)) {
+      sv.dash = ws
+    } else if (canPlayHls(ws.source, ws.mimeType)) {
+      sv.hls = ws
     } else {
-      sv.master = s
+      sv.mpegts = ws
     }
   })
   return sv
 }
 
-export function buildSourcesPriorityList(
-  sources: SourceVariants,
+export function buildMediaSourcesList(
+  sources: PlayerMediaSourceDesc[],
   priorityTransport: TransportPreference = 'auto',
-): PlayerMediaSource[] {
-  const msl: string[] = []
-  switch (priorityTransport) {
-    case 'dash':
-      addDash()
-      break
-    case 'hls':
-      addHls()
-      break
-    case 'mpegts':
-      addMpegts()
-      break
-    case 'auto':
-      addDash()
-      addHls()
-      break
-  }
-  Object.values(sources).forEach((s) => {
-    if (s) {
-      msl.push(s)
-    }
-  })
-  return msl
+): PlayerMediaSourceDesc[] {
+  const [preferred, rest] = sources.reduce(
+    priorityTransport === 'dash' || priorityTransport === 'auto'
+      ? (
+          acc: [PlayerMediaSourceDesc[], PlayerMediaSourceDesc[]],
+          item: PlayerMediaSourceDesc,
+        ) => {
+          if (canPlayDash(item.source, item.mimeType)) {
+            acc[0].push(item)
+          } else if (canPlayHls(item.source, item.mimeType)) {
+            acc[1].push(item)
+          }
+          return acc
+        }
+      : (
+          acc: [PlayerMediaSourceDesc[], PlayerMediaSourceDesc[]],
+          item: PlayerMediaSourceDesc,
+        ) => {
+          if (canPlayHls(item.source, item.mimeType)) {
+            acc[0].push(item)
+          } else if (canPlayDash(item.source, item.mimeType)) {
+            acc[1].push(item)
+          }
+          return acc
+        },
+    [[], []],
+  )
+  return preferred.concat(rest)
+}
 
-  function addMpegts() {
-    if (sources.mpegts) {
-      msl.push(sources.mpegts)
-      sources.mpegts = null
-    }
-  }
+export function unwrapSource(s: PlayerMediaSource): string {
+  return typeof s === 'string' ? s : s.source
+}
 
-  function addHls() {
-    if (sources.hls && HlsPlayback.canPlay(sources.hls, undefined)) {
-      msl.push(sources.hls)
-      sources.hls = null
-    }
-    if (
-      sources.master?.endsWith('.m3u8') &&
-      HlsPlayback.canPlay(sources.master, undefined)
-    ) {
-      msl.push(sources.master)
-      sources.master = null
-    }
+export function wrapSource(s: PlayerMediaSource): PlayerMediaSourceDesc {
+  return typeof s === 'string' ? { source: s, mimeType: guessMimeType(s) } : s
+}
+
+function guessMimeType(s: string): string {
+  if (s.endsWith('.mpd')) {
+    return 'application/dash+xml'
   }
+  if (s.endsWith('.m3u8')) {
+    return 'application/vnd.apple.mpegurl'
+  }
+  throw new Error('Unrecognized media source type')
+}
 
-  function addDash() {
-    if (sources.dash && DashPlayback.canPlay(sources.dash, undefined)) {
-      msl.push(sources.dash)
-      sources.dash = null
-    }
+export function isDashSource(source: string, mimeType?: string) {
+  if (mimeType) {
+    return mimeType === 'application/dash+xml'
   }
+  return source.endsWith('.mpd')
 }
 
-export function unwrapSource(s: PlayerMediaSource): string {
-  return typeof s === 'string' ? s : s.source
+export function isHlsSource(source: string, mimeType?: string) {
+  if (mimeType) {
+    return ['application/vnd.apple.mpegurl', 'application/x-mpegURL'].includes(
+      mimeType,
+    )
+  }
+  return source.endsWith('.m3u8')
 }

package/src/utils/testUtils.ts

@@ -0,0 +1,15 @@
+export function isDashSource(source: string, mimeType?: string) {
+  if (mimeType) {
+    return mimeType === 'application/dash+xml'
+  }
+  return source.endsWith('.mpd')
+}
+
+export function isHlsSource(source: string, mimeType?: string) {
+  if (mimeType) {
+    return ['application/vnd.apple.mpegurl', 'application/x-mpegURL'].includes(
+      mimeType,
+    )
+  }
+  return source.endsWith('.m3u8')
+}

package/tsconfig.json

@@ -26,15 +26,6 @@
       "DOM.Iterable"
     ],
     "module": "ESNext",
-    // "paths": {
-    //   // "@assets/*": ["src/assets/*"],
-    //   // "@vendor/*": ["src/vendor/*"],
-    // },
-    "types": [
-      "node",
-      // "@clappr/core",
-      // "@clappr/plugins",
-    ],
     "typeRoots": [
       "node_modules/@types",
       "src/typings"