mediabunny 1.0.2 → 1.0.4

package/dist/modules/codec.d.ts

@@ -0,0 +1,250 @@
+/*!
+ * Copyright (c) 2025-present, Vanilagy and contributors
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+import { Av1CodecInfo, AvcDecoderConfigurationRecord, HevcDecoderConfigurationRecord, Vp9CodecInfo } from './codec-data';
+import { SubtitleMetadata } from './subtitles';
+/**
+ * List of known video codecs, ordered by encoding preference.
+ * @public
+ */
+export declare const VIDEO_CODECS: readonly ["avc", "hevc", "vp9", "av1", "vp8"];
+/**
+ * List of known PCM (uncompressed) audio codecs, ordered by encoding preference.
+ * @public
+ */
+export declare const PCM_AUDIO_CODECS: readonly ["pcm-s16", "pcm-s16be", "pcm-s24", "pcm-s24be", "pcm-s32", "pcm-s32be", "pcm-f32", "pcm-f32be", "pcm-f64", "pcm-f64be", "pcm-u8", "pcm-s8", "ulaw", "alaw"];
+/**
+ * List of known compressed audio codecs, ordered by encoding preference.
+ * @public
+ */
+export declare const NON_PCM_AUDIO_CODECS: readonly ["aac", "opus", "mp3", "vorbis", "flac"];
+/**
+ * List of known audio codecs, ordered by encoding preference.
+ * @public
+ */
+export declare const AUDIO_CODECS: readonly ["aac", "opus", "mp3", "vorbis", "flac", "pcm-s16", "pcm-s16be", "pcm-s24", "pcm-s24be", "pcm-s32", "pcm-s32be", "pcm-f32", "pcm-f32be", "pcm-f64", "pcm-f64be", "pcm-u8", "pcm-s8", "ulaw", "alaw"];
+/**
+ * List of known subtitle codecs, ordered by encoding preference.
+ * @public
+ */
+export declare const SUBTITLE_CODECS: readonly ["webvtt"];
+/**
+ * Union type of known video codecs.
+ * @public
+ */
+export type VideoCodec = typeof VIDEO_CODECS[number];
+/**
+ * Union type of known audio codecs.
+ * @public
+ */
+export type AudioCodec = typeof AUDIO_CODECS[number];
+export type PcmAudioCodec = typeof PCM_AUDIO_CODECS[number];
+/**
+ * Union type of known subtitle codecs.
+ * @public
+ */
+export type SubtitleCodec = typeof SUBTITLE_CODECS[number];
+/**
+ * Union type of known media codecs.
+ * @public
+ */
+export type MediaCodec = VideoCodec | AudioCodec | SubtitleCodec;
+export declare const VP9_LEVEL_TABLE: {
+    maxPictureSize: number;
+    maxBitrate: number;
+    level: number;
+}[];
+export declare const buildVideoCodecString: (codec: VideoCodec, width: number, height: number, bitrate: number) => string;
+export declare const generateVp9CodecConfigurationFromCodecString: (codecString: string) => number[];
+export declare const generateAv1CodecConfigurationFromCodecString: (codecString: string) => number[];
+export declare const extractVideoCodecString: (trackInfo: {
+    width: number;
+    height: number;
+    codec: VideoCodec | null;
+    codecDescription: Uint8Array | null;
+    colorSpace: VideoColorSpaceInit | null;
+    avcCodecInfo: AvcDecoderConfigurationRecord | null;
+    hevcCodecInfo: HevcDecoderConfigurationRecord | null;
+    vp9CodecInfo: Vp9CodecInfo | null;
+    av1CodecInfo: Av1CodecInfo | null;
+}) => string;
+export declare const buildAudioCodecString: (codec: AudioCodec, numberOfChannels: number, sampleRate: number) => "opus" | "mp3" | "vorbis" | "flac" | "pcm-s16" | "pcm-s16be" | "pcm-s24" | "pcm-s24be" | "pcm-s32" | "pcm-s32be" | "pcm-f32" | "pcm-f32be" | "pcm-f64" | "pcm-f64be" | "pcm-u8" | "pcm-s8" | "ulaw" | "alaw" | "mp4a.40.29" | "mp4a.40.5" | "mp4a.40.2";
+export type AacCodecInfo = {
+    isMpeg2: boolean;
+};
+export declare const extractAudioCodecString: (trackInfo: {
+    codec: AudioCodec | null;
+    codecDescription: Uint8Array | null;
+    aacCodecInfo: AacCodecInfo | null;
+}) => string;
+export declare const parseAacAudioSpecificConfig: (bytes: Uint8Array | null) => {
+    objectType: number;
+    frequencyIndex: number;
+    sampleRate: number | null;
+    channelConfiguration: number;
+    numberOfChannels: number | null;
+};
+export declare const OPUS_INTERNAL_SAMPLE_RATE = 48000;
+export declare const parsePcmCodec: (codec: PcmAudioCodec) => {
+    dataType: "ulaw";
+    sampleSize: 1;
+    littleEndian: boolean;
+    silentValue: number;
+} | {
+    dataType: "alaw";
+    sampleSize: 1;
+    littleEndian: boolean;
+    silentValue: number;
+} | {
+    dataType: "unsigned" | "signed" | "float";
+    sampleSize: 8 | 1 | 2 | 4 | 3;
+    littleEndian: boolean;
+    silentValue: number;
+};
+export declare const inferCodecFromCodecString: (codecString: string) => MediaCodec | null;
+export declare const getVideoEncoderConfigExtension: (codec: VideoCodec) => {
+    avc: {
+        format: "avc";
+    };
+    hevc?: undefined;
+} | {
+    hevc: {
+        format: "hevc";
+    };
+    avc?: undefined;
+} | {
+    avc?: undefined;
+    hevc?: undefined;
+};
+export declare const getAudioEncoderConfigExtension: (codec: AudioCodec) => {
+    aac: {
+        format: "aac";
+    };
+    opus?: undefined;
+} | {
+    opus: {
+        format: "opus";
+    };
+    aac?: undefined;
+} | {
+    aac?: undefined;
+    opus?: undefined;
+};
+/**
+ * Represents a subjective media quality level.
+ * @public
+ */
+export declare class Quality {
+}
+/**
+ * Represents a very low media quality.
+ * @public
+ */
+export declare const QUALITY_VERY_LOW: Quality;
+/**
+ * Represents a low media quality.
+ * @public
+ */
+export declare const QUALITY_LOW: Quality;
+/**
+ * Represents a medium media quality.
+ * @public
+ */
+export declare const QUALITY_MEDIUM: Quality;
+/**
+ * Represents a high media quality.
+ * @public
+ */
+export declare const QUALITY_HIGH: Quality;
+/**
+ * Represents a very high media quality.
+ * @public
+ */
+export declare const QUALITY_VERY_HIGH: Quality;
+export declare const validateVideoChunkMetadata: (metadata: EncodedVideoChunkMetadata | undefined) => void;
+export declare const validateAudioChunkMetadata: (metadata: EncodedAudioChunkMetadata | undefined) => void;
+export declare const validateSubtitleMetadata: (metadata: SubtitleMetadata | undefined) => void;
+/**
+ * Checks if the browser is able to encode the given codec.
+ * @public
+ */
+export declare const canEncode: (codec: MediaCodec) => Promise<boolean>;
+/**
+ * Checks if the browser is able to encode the given video codec with the given parameters.
+ * @public
+ */
+export declare const canEncodeVideo: (codec: VideoCodec, { width, height, bitrate }?: {
+    width?: number;
+    height?: number;
+    bitrate?: number | Quality;
+}) => Promise<boolean>;
+/**
+ * Checks if the browser is able to encode the given audio codec with the given parameters.
+ * @public
+ */
+export declare const canEncodeAudio: (codec: AudioCodec, { numberOfChannels, sampleRate, bitrate }?: {
+    numberOfChannels?: number;
+    sampleRate?: number;
+    bitrate?: number | Quality;
+}) => Promise<boolean>;
+/**
+ * Checks if the browser is able to encode the given subtitle codec.
+ * @public
+ */
+export declare const canEncodeSubtitles: (codec: SubtitleCodec) => Promise<boolean>;
+/**
+ * Returns the list of all media codecs that can be encoded by the browser.
+ * @public
+ */
+export declare const getEncodableCodecs: () => Promise<MediaCodec[]>;
+/**
+ * Returns the list of all video codecs that can be encoded by the browser.
+ * @public
+ */
+export declare const getEncodableVideoCodecs: (checkedCodecs?: VideoCodec[], options?: {
+    width?: number;
+    height?: number;
+    bitrate?: number | Quality;
+}) => Promise<VideoCodec[]>;
+/**
+ * Returns the list of all audio codecs that can be encoded by the browser.
+ * @public
+ */
+export declare const getEncodableAudioCodecs: (checkedCodecs?: AudioCodec[], options?: {
+    numberOfChannels?: number;
+    sampleRate?: number;
+    bitrate?: number | Quality;
+}) => Promise<AudioCodec[]>;
+/**
+ * Returns the list of all subtitle codecs that can be encoded by the browser.
+ * @public
+ */
+export declare const getEncodableSubtitleCodecs: (checkedCodecs?: SubtitleCodec[]) => Promise<SubtitleCodec[]>;
+/**
+ * Returns the first video codec from the given list that can be encoded by the browser.
+ * @public
+ */
+export declare const getFirstEncodableVideoCodec: (checkedCodecs: VideoCodec[], options?: {
+    width?: number;
+    height?: number;
+    bitrate?: number | Quality;
+}) => Promise<VideoCodec | null>;
+/**
+ * Returns the first audio codec from the given list that can be encoded by the browser.
+ * @public
+ */
+export declare const getFirstEncodableAudioCodec: (checkedCodecs: AudioCodec[], options?: {
+    numberOfChannels?: number;
+    sampleRate?: number;
+    bitrate?: number | Quality;
+}) => Promise<AudioCodec | null>;
+/**
+ * Returns the first subtitle codec from the given list that can be encoded by the browser.
+ * @public
+ */
+export declare const getFirstEncodableSubtitleCodec: (checkedCodecs: SubtitleCodec[]) => Promise<SubtitleCodec | null>;
+//# sourceMappingURL=codec.d.ts.map

package/dist/modules/codec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/codec.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACN,YAAY,EACZ,6BAA6B,EAC7B,8BAA8B,EAC9B,YAAY,EACZ,MAAM,cAAc,CAAC;AActB,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,YAAY,+CAMf,CAAC;AACX;;;GAGG;AACH,eAAO,MAAM,gBAAgB,uKAenB,CAAC;AACX;;;GAGG;AACH,eAAO,MAAM,oBAAoB,mDAMvB,CAAC;AACX;;;GAGG;AACH,eAAO,MAAM,YAAY,+MAGf,CAAC;AACX;;;GAGG;AACH,eAAO,MAAM,eAAe,qBAElB,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AACrD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AACrD,MAAM,MAAM,aAAa,GAAG,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC5D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AAC3D;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,CAAC;AAmDjE,eAAO,MAAM,eAAe;;;;GAe3B,CAAC;AAiCF,eAAO,MAAM,qBAAqB,GAAI,OAAO,UAAU,EAAE,OAAO,MAAM,EAAE,QAAQ,MAAM,EAAE,SAAS,MAAM,WA+DtG,CAAC;AAEF,eAAO,MAAM,4CAA4C,GAAI,aAAa,MAAM,aAgB/E,CAAC;AAEF,eAAO,MAAM,4CAA4C,GAAI,aAAa,MAAM,aAkC/E,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,WAAW;IAClD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IACzB,gBAAgB,EAAE,UAAU,GAAG,IAAI,CAAC;IACpC,UAAU,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACvC,YAAY,EAAE,6BAA6B,GAAG,IAAI,CAAC;IACnD,aAAa,EAAE,8BAA8B,GAAG,IAAI,CAAC;IACrD,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;CAClC,WAgKA,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAI,OAAO,UAAU,EAAE,kBAAkB,MAAM,EAAE,YAAY,MAAM,4PA2BpG,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,WAAW;IAClD,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IACzB,gBAAgB,EAAE,UAAU,GAAG,IAAI,CAAC;IACpC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;CAClC,WA2BA,CAAC;AAEF,eAAO,MAAM,2BAA2B,GAAI,OAAO,UAAU,GAAG,IAAI;;;;;;CAgDnE,CAAC;AAEF,eAAO,MAAM,yBAAyB,QAAQ,CAAC;AAI/C,eAAO,MAAM,aAAa,GAAI,OAAO,aAAa;;;;;;;;;;;;;;;CA0BjD,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAI,aAAa,MAAM,KAAG,UAAU,GAAG,IA4C5E,CAAC;AAEF,eAAO,MAAM,8BAA8B,GAAI,OAAO,UAAU;;;;;;;;;;;;;CAgB/D,CAAC;AAEF,eAAO,MAAM,8BAA8B,GAAI,OAAO,UAAU;;;;;;;;;;;;;CAgB/D,CAAC;AAEF;;;GAGG;AACH,qBAAa,OAAO;CAwEnB;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,SAAmB,CAAC;AACjD;;;GAGG;AACH,eAAO,MAAM,WAAW,SAAmB,CAAC;AAC5C;;;GAGG;AACH,eAAO,MAAM,cAAc,SAAiB,CAAC;AAC7C;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAiB,CAAC;AAC3C;;;GAGG;AACH,eAAO,MAAM,iBAAiB,SAAiB,CAAC;AAQhD,eAAO,MAAM,0BAA0B,GAAI,UAAU,yBAAyB,GAAG,SAAS,SAmIzF,CAAC;AAIF,eAAO,MAAM,0BAA0B,GAAI,UAAU,yBAAyB,GAAG,SAAS,SAqIzF,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,UAAU,gBAAgB,GAAG,SAAS,SAgB9E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,UAAU,qBAU1C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAU,OAAO,UAAU,EAAE,6BAA+C;IACtG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,qBAmDL,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAU,OAAO,UAAU,EAAE,4CAA+D;IACtH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,qBAsDL,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAU,OAAO,aAAa,qBAM5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAa,OAAO,CAAC,UAAU,EAAE,CAQ/D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GACnC,gBAA2C,UAAU,EAAE,EACvD,UAAU;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B,KACC,OAAO,CAAC,UAAU,EAAE,CAGtB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GACnC,gBAA2C,UAAU,EAAE,EACvD,UAAU;IACT,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B,KACC,OAAO,CAAC,UAAU,EAAE,CAGtB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,GACtC,gBAA8C,aAAa,EAAE,KAC3D,OAAO,CAAC,aAAa,EAAE,CAGzB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GACvC,eAAe,UAAU,EAAE,EAC3B,UAAU;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B,KACC,OAAO,CAAC,UAAU,GAAG,IAAI,CAQ3B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GACvC,eAAe,UAAU,EAAE,EAC3B,UAAU;IACT,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B,KACC,OAAO,CAAC,UAAU,GAAG,IAAI,CAQ3B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,8BAA8B,GAC1C,eAAe,aAAa,EAAE,KAC5B,OAAO,CAAC,aAAa,GAAG,IAAI,CAQ9B,CAAC"}