yetangitu/bitjs
1
0
Fork 0
mirror of https://github.com/codedread/bitjs synced 2025-10-04 10:09:16 +02:00
Code Issues Releases Wiki Activity

Correct some typos, expose codecs in the main module (woops), and provide Typescript types (d.ts files)

Browse source
This commit is contained in:
Jeff Schiller 2022-10-30 16:54:53 -07:00
parent 28e8a8e449
commit d5971c0fdb
23 changed files with 701 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

97
types/codecs/codecs.d.ts vendored Normal file
View file

@ -0,0 +1,97 @@
/**
* This module helps interpret ffprobe -print_format json output.
* Its coverage is pretty sparse right now, so send me pull requests!
*/
/**
* @typedef ProbeStream ffprobe -show_streams -print_format json. Only the fields we care about.
* @property {number} index
* @property {string} codec_name
* @property {string} codec_long_name
* @property {string} profile
* @property {string} codec_type Either 'audio' or 'video'.
* @property {string} codec_tag_string
* @property {string} id
* @property {number?} level
* @property {number?} width
* @property {number?} height
* @property {string} r_frame_rate Like "60000/1001"
*/
/**
* @typedef ProbeFormat ffprobe -show_format -print_format json. Only the fields we care about.
* @property {string} filename
* @property {string} format_name
* @property {string} duration Number of seconds, as a string like "473.506367".
* @property {string} size Number of bytes, as a string.
* @property {string} bit_rate Bit rate, as a string.
*/
/**
* @typedef ProbeInfo ffprobe -show_format -show_streams -print_format json
* @property {ProbeStream[]} streams
* @property {ProbeFormat} format
*/
/**
* TODO: Reconcile this with file/sniffer.js findMimeType() which does signature matching.
* @param {ProbeInfo} info
* @returns {string}
*/
export function getShortMIMEString(info: ProbeInfo): string;
/**
* Accepts the ffprobe JSON output and returns an ISO MIME string with parameters (RFC6381), such
* as 'video/mp4; codecs="avc1.4D4028, mp4a.40.2"'. This string should be suitable to be used on
* the server as the Content-Type header of a media stream which can subsequently be used on the
* client as the type value of a SourceBuffer object `mediaSource.addSourceBuffer(contentType)`.
* NOTE: For now, this method fails hard (throws an error) when it encounters a format/codec it
* does not recognize. Please file a bug or send a PR.
* @param {ProbeInfo} info
* @returns {string}
*/
export function getFullMIMEString(info: ProbeInfo): string;
/**
* ffprobe -show_streams -print_format json. Only the fields we care about.
*/
export type ProbeStream = {
index: number;
codec_name: string;
codec_long_name: string;
profile: string;
/**
* Either 'audio' or 'video'.
*/
codec_type: string;
codec_tag_string: string;
id: string;
level: number | null;
width: number | null;
height: number | null;
/**
* Like "60000/1001"
*/
r_frame_rate: string;
};
/**
* ffprobe -show_format -print_format json. Only the fields we care about.
*/
export type ProbeFormat = {
filename: string;
format_name: string;
/**
* Number of seconds, as a string like "473.506367".
*/
duration: string;
/**
* Number of bytes, as a string.
*/
size: string;
/**
* Bit rate, as a string.
*/
bit_rate: string;
};
/**
* ffprobe -show_format -show_streams -print_format json
*/
export type ProbeInfo = {
streams: ProbeStream[];
format: ProbeFormat;
};
//# sourceMappingURL=codecs.d.ts.map