media-codecs

Get a codec parameter string (like "avc1.4d002a") from human readable options (like { name: "Main", level: "4.2" }) and back to a descriptive name ("AVC Main Profile Level 4.2").

Useful for checking supported codecs with HTMLMediaElement.canPlayType / MediaSource.isTypeSupported and to pass as option for the WebCodecs API VideoEncoder configure parameters. Supports Advanced Video Coding (AVC), Video Partition (VP8/VP9), AOMedia Video (AV1) and partially High Efficiency Video Coding HEVC.

See the demo that checks current browser support of all video codecs and MDN's Codecs in common media types.

Installation

npm install media-codecs

Usage

import { AVC } from "media-codecs";

const codec = AVC.getCodec({ name: "Main", level: "4.2" });
// => avc1.4d002a
const mimeType = `video/mp4;codecs="${codec}"`;

console.log(MediaSource.isTypeSupported(mimeType));

Roadmap:

[ ] HEVC compatibility and constraints
[ ] VP, HEVC and AV1 optional parameters

API

Modules

index
vp
hevc
avc
av

Typedefs

VCProfileItem : Object
CodecItem : Object
MediaCodecItem : Object
VPCodecOptions : Object
AVCodecOptions : Object
AVCCodecOptions : Object
HEVCCodecOptions : Object

index

vp

vp
- ~VP_CODECS : Array.<CodecItem>
- ~VP_PROFILES : Array.<number>
- ~VP_LEVELS : Array.<number>
- ~VP_BIT_DEPTH : Array.<number>
- ~getAllItems() ⇒ Array.<MediaCodecItem>
- ~getCodec(options) ⇒ string
- ~getCodecName(codec) ⇒ string

vp~VP_CODECS : `Array.<CodecItem>`

List of codecs

Kind: inner constant of vp

vp~VP_PROFILES : `Array.<number>`

List of VP profiles numbers

Kind: inner constant of vp

vp~VP_LEVELS : `Array.<number>`

VP Levels

Kind: inner constant of vp See: webmproject.org

vp~VP_BIT_DEPTH : `Array.<number>`

List of supported bit depth

Kind: inner constant of vp

vp~getAllItems() ⇒ `Array.<MediaCodecItem>`

Return a list of all possible codec parameter string and their human readable names

Kind: inner method of vp

vp~getCodec(options) ⇒ `string`

Get a codec parameter string

Kind: inner method of vp

Param	Type
options	`VPCodecOptions`

vp~getCodecName(codec) ⇒ `string`

Get a codec human readbable name

Kind: inner method of vp

Param	Type	Description
codec	`string`	a codec string (avc1[.PPCCLL] eg. "avc1.640028")

hevc

hevc
- ~See : Array.<VCProfileItem>
- ~HEVC_PROFILE_COMPATIBILITY : Array.<number>
- ~HEVC_LEVELS : Array.<number>
- ~HEVC_TIER : Array.<number>
- ~getAllItems() ⇒ Array.<MediaCodecItem>
- ~getCodec(options) ⇒ string
- ~getCodecName(codec) ⇒ string

hevc~See : `Array.<VCProfileItem>`

List of profiles with their profile numbers (PP) and the compatibility (C).

Kind: inner constant of hevc

hevc~HEVC_PROFILE_COMPATIBILITY : `Array.<number>`

HEVC Profile Compatibility as a number in the 0..32 range TODO: is that correct

Kind: inner constant of hevc

hevc~HEVC_LEVELS : `Array.<number>`

HEVC Levels

Kind: inner constant of hevc See: hevc-levels

hevc~HEVC_TIER : `Array.<number>`

List of supported tier

Kind: inner constant of hevc

hevc~getAllItems() ⇒ `Array.<MediaCodecItem>`

Return a list of all possible codec parameter string and their human readable names

Kind: inner method of hevc

hevc~getCodec(options) ⇒ `string`

Get a codec parameter string

Kind: inner method of hevc

Param	Type
options	`HEVCCodecOptions`

hevc~getCodecName(codec) ⇒ `string`

Get a codec human readbable name

Kind: inner method of hevc

Param	Type	Description
codec	`string`	a codec string (cccc.PP.C.TLL.CC eg. "hev1.1.3.H34.B0")

avc

avc
- ~AVC_PROFILES : Array.<VCProfileItem>
- ~AVC_LEVELS : Array.<number>
- ~getAllItems() ⇒ Array.<MediaCodecItem>
- ~getCodec(options) ⇒ string
- ~getCodecName(codec) ⇒ string

avc~AVC_PROFILES : `Array.<VCProfileItem>`

List of profiles with their profile numbers (PP) and the constraints component (CC).

Kind: inner constant of avc

avc~AVC_LEVELS : `Array.<number>`

AVC Levels

Kind: inner constant of avc See: wikipedia.org

avc~getAllItems() ⇒ `Array.<MediaCodecItem>`

Return a list of all possible codec parameter string and their human readable names

Kind: inner method of avc

avc~getCodec(options) ⇒ `string`

Get a codec parameter string

Kind: inner method of avc

Param	Type
options	`AVCCodecOptions`

avc~getCodecName(codec) ⇒ `string`

Get a codec human readbable name

Kind: inner method of avc

Param	Type	Description
codec	`string`	a codec string (cccc.PP.LL.DD eg. "vp09.00.10.08")

av

av
- ~AV_CODECS : Array.<CodecItem>
- ~AV_PROFILES : Array.<number>
- ~AV_LEVELS : Array.<number>
- ~AV_TIER : Array.<number>
- ~AV_BIT_DEPTH : Array.<number>
- ~getAllItems() ⇒ Array.<MediaCodecItem>
- ~getCodec(options) ⇒ string
- ~getCodecName(codec) ⇒ string

av~AV_CODECS : `Array.<CodecItem>`

List of codecs

Kind: inner constant of av

av~AV_PROFILES : `Array.<number>`

List of AV profiles numbers

Kind: inner constant of av See: av1-spec

av~AV_LEVELS : `Array.<number>`

AV Levels

Kind: inner constant of av See: av1-spec

av~AV_TIER : `Array.<number>`

List of supported tier

Kind: inner constant of av

av~AV_BIT_DEPTH : `Array.<number>`

List of supported bit depth

Kind: inner constant of av

av~getAllItems() ⇒ `Array.<MediaCodecItem>`

Return a list of all possible codec parameter string and their human readable names

Kind: inner method of av

av~getCodec(options) ⇒ `string`

Get a codec parameter string

Kind: inner method of av

Param	Type
options	`AVCodecOptions`

av~getCodecName(codec) ⇒ `string`

Get a codec human readbable name

Kind: inner method of av

Param	Type	Description
codec	`string`	a codec string (av01.P.LLT.DD eg. "av01.P.LLT.DD")