12 Commits

3 changed files with 344 additions and 302 deletions

View File

@ -1,7 +1,6 @@
MIT License
MIT+NIGGER License
Copyright (c) 2023 Ryan He
Copyright (c) 2021 Théo Le Calvar
Copyright (c) NiceCrew Technologies
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@ -13,6 +12,8 @@ furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The above copyright notice, this permission notice and the word "NIGGER" shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

321
dist/main.js vendored
View File

@ -5,10 +5,11 @@ let logger;
let transcodingManager;
const DEFAULT_HARDWARE_DECODE = false;
const DEFAULT_VOD_QUALITY = "p7";
const DEFAULT_HEVC_PROFILE = "main10";
const DEFAULT_HEVC_PROFILE = "main";
const DEFAULT_LIVE_QUALITY = "hq";
const DEFAULT_CQ_H264 = 26;
const DEFAULT_CQ_HEVC = 28;
const DEFAULT_H264_PROFILE = "main";
const DEFAULT_BITRATES = new Map([
[0, 64 * 1000],
[144, 320 * 1000],
@ -17,7 +18,7 @@ const DEFAULT_BITRATES = new Map([
[720, 2800 * 1000],
[1080, 5200 * 1000],
[1440, 10000 * 1000],
[2160, 22000 * 1000]
[2160, 22000 * 1000],
]);
let pluginSettings = {
hardwareDecode: DEFAULT_HARDWARE_DECODE,
@ -26,101 +27,125 @@ let pluginSettings = {
hevcProfile: DEFAULT_HEVC_PROFILE,
cqH264: DEFAULT_CQ_H264,
cqHEVC: DEFAULT_CQ_HEVC,
baseBitrate: new Map(DEFAULT_BITRATES)
h264Profile: DEFAULT_H264_PROFILE,
baseBitrate: new Map(DEFAULT_BITRATES),
};
let latestStreamNum = 9999;
async function register({ settingsManager, peertubeHelpers, transcodingManager: transcode, registerSetting }) {
async function register({
settingsManager,
peertubeHelpers,
transcodingManager: transcode,
registerSetting,
}) {
logger = peertubeHelpers.logger;
transcodingManager = transcode;
logger.info("Registering peertube-plugin-nctv-hardware-encode");
const encoder = 'h264_nvenc';
const hevc = 'hevc_nvenc';
const profileName = 'nctv-nvenc';
const hevcProfile = 'nctv-hevc';
const encoder = "h264_nvenc";
const hevc = "hevc_nvenc";
const profileName = "nctv-nvenc";
const hevcProfile = "nctv-hevc";
transcodingManager.addVODProfile(encoder, profileName, vodBuilder);
transcodingManager.addVODEncoderPriority('video', encoder, 1000);
transcodingManager.addVODEncoderPriority("video", encoder, 1000);
transcodingManager.addLiveProfile(encoder, profileName, liveBuilder);
transcodingManager.addLiveEncoderPriority('video', encoder, 1000);
transcodingManager.addLiveEncoderPriority("video", encoder, 1000);
transcodingManager.addVODProfile(hevc, hevcProfile, hevcVODBuilder);
transcodingManager.addVODEncoderPriority('video', hevc, 900);
transcodingManager.addVODEncoderPriority("video", hevc, 900);
transcodingManager.addLiveProfile(hevc, hevcProfile, hevcLiveBuilder);
transcodingManager.addLiveEncoderPriority('video', hevc, 900);
transcodingManager.addLiveEncoderPriority("video", hevc, 900);
await loadSettings(settingsManager);
registerSetting({
name: 'hardware-decode',
label: 'Hardware decode',
type: 'input-checkbox',
descriptionHTML: 'Use hardware video decoder instead of software decoder. This will slightly improve performance but may cause some issues with some videos. If you encounter issues, disable this option and restart failed jobs.',
name: "hardware-decode",
label: "Hardware decode",
type: "input-checkbox",
descriptionHTML:
"Use hardware video decoder instead of software decoder. This will slightly improve performance but may cause some issues with some videos. If you encounter issues, disable this option and restart failed jobs.",
default: DEFAULT_HARDWARE_DECODE,
private: false
private: false,
});
registerSetting({
name: 'cq-h264',
label: 'CQ Value for H264_nvenc',
type: 'input',
descriptionHTML: 'Sets the -cq value for h264_nvenc encoder. Valid values are between 0 and 51 (lossess and AIDS, respectively)',
name: "cq-h264",
label: "CQ Value for H264_nvenc",
type: "input",
descriptionHTML:
"Sets the -cq value for h264_nvenc encoder. Valid values are between 0 and 51 (lossess and AIDS, respectively)",
default: DEFAULT_CQ_H264,
private: false
private: false,
});
registerSetting({
name: 'cq-hevc',
label: 'CQ Value for hevc_nvenc',
type: 'input',
descriptionHTML: 'Sets the -cq value for hevc_nvenc encoder. Valid values are between 0 and 51 (lossess and AIDS, respectively)',
name: "cq-hevc",
label: "CQ Value for hevc_nvenc",
type: "input",
descriptionHTML:
"Sets the -cq value for hevc_nvenc encoder. Valid values are between 0 and 51 (lossess and AIDS, respectively)",
default: DEFAULT_CQ_HEVC,
private: false
private: false,
});
registerSetting({
name: 'vod-quality',
label: 'VOD Quality',
type: 'select',
name: "vod-quality",
label: "VOD Quality",
type: "select",
options: [
{ label: 'fastest', value: 'p1' },
{ label: 'faster', value: 'p2' },
{ label: 'fast', value: 'p3' },
{ label: 'medium (default)', value: 'p4' },
{ label: 'slow', value: 'p5' },
{ label: 'slower', value: 'p6' },
{ label: 'slowest', value: 'p7' }
{ label: "fastest", value: "p1" },
{ label: "faster", value: "p2" },
{ label: "fast", value: "p3" },
{ label: "medium (default)", value: "p4" },
{ label: "slow", value: "p5" },
{ label: "slower", value: "p6" },
{ label: "slowest", value: "p7" },
],
descriptionHTML: 'This parameter controls the speed / quality tradeoff. Slower speed mean better quality. Faster speed mean lower quality. This setting is hardware dependent, you may need to experiment to find the best value for your hardware.',
descriptionHTML:
"This parameter controls the speed / quality tradeoff. Slower speed mean better quality. Faster speed mean lower quality. This setting is hardware dependent, you may need to experiment to find the best value for your hardware.",
default: DEFAULT_VOD_QUALITY.toString(),
private: false
private: false,
});
registerSetting({
name: 'hevc-profile',
label: 'HEVC Profile',
type: 'select',
name: "hevc-profile",
label: "HEVC Profile",
type: "select",
options: [
{ label: 'main', value: 'main' },
{ label: 'main10 (default)', value: 'main10' },
{ label: 'rext', value: 'rext' }
{ label: "main (default)", value: "main" },
{ label: "main10", value: "main10" },
{ label: "rext", value: "rext" },
],
descriptionHTML: 'Set the HEVC profile',
descriptionHTML: "Set the HEVC profile",
default: DEFAULT_HEVC_PROFILE.toString(),
private: false
private: false,
});
registerSetting({
name: 'live-quality',
label: 'Live Quality',
type: 'select',
name: "h264-profile",
label: "H264 Profile",
type: "select",
options: [
{ label: 'low latency', value: 'll' },
{ label: 'high quality (default)', value: 'hq' },
{ label: 'low latency high performance', value: 'ull' }
{ label: "main (default)", value: "main" },
{ label: "high", value: "high" },
{ label: "high444p", value: "high444p" },
],
descriptionHTML: 'This parameter controls the speed / quality tradeoff. High performance mean lower quality.',
default: DEFAULT_LIVE_QUALITY.toString(),
private: false
descriptionHTML: "Set the H264 profile",
default: DEFAULT_H264_PROFILE.toString(),
private: false,
});
registerSetting({
name: 'base-bitrate-description',
label: 'Base bitrate',
type: 'html',
html: '',
name: "live-quality",
label: "Live Quality",
type: "select",
options: [
{ label: "low latency", value: "ll" },
{ label: "high quality (default)", value: "hq" },
{ label: "low latency high performance", value: "ull" },
],
descriptionHTML:
"This parameter controls the speed / quality tradeoff. High performance mean lower quality.",
default: DEFAULT_LIVE_QUALITY.toString(),
private: false,
});
registerSetting({
name: "base-bitrate-description",
label: "Base bitrate",
type: "html",
html: "",
descriptionHTML: `The base bitrate for video in bits. We take the min bitrate between the bitrate setting and video bitrate.<br/>This is the bitrate used when the video is transcoded at 30 FPS. The bitrate will be scaled linearly between this value and the maximum bitrate when the video is transcoded at 60 FPS. Wrong values are replaced by default values.`,
private: true,
});
@ -129,10 +154,10 @@ async function register({ settingsManager, peertubeHelpers, transcodingManager:
registerSetting({
name: `base-bitrate-${resolution}`,
label: `Base bitrate for ${printResolution(resolution)}`,
type: 'input',
type: "input",
default: DEFAULT_BITRATES.get(resolution)?.toString(),
descriptionHTML: `Default value: ${DEFAULT_BITRATES.get(resolution)}`,
private: false
private: false,
});
}
settingsManager.onSettingsChange(async (settings) => {
@ -147,27 +172,45 @@ async function unregister() {
}
exports.unregister = unregister;
async function loadSettings(settingsManager) {
pluginSettings.hardwareDecode = await settingsManager.getSetting('hardware-decode') || DEFAULT_HARDWARE_DECODE;
pluginSettings.vodQuality = parseInt(await settingsManager.getSetting('vod-quality')) || DEFAULT_VOD_QUALITY;
pluginSettings.liveQuality = parseInt(await settingsManager.getSetting('live-quality')) || DEFAULT_LIVE_QUALITY;
pluginSettings.hevcProfile = parseInt(await settingsManager.getSetting('hevc-profile')) || DEFAULT_HEVC_PROFILE;
pluginSettings.cqH264 = parseInt(await settingsManager.getSetting('cq-h264')) || DEFAULT_CQ_H264;
pluginSettings.cqHEVC = parseInt(await settingsManager.getSetting('cq-hevc')) || DEFAULT_CQ_HEVC;
pluginSettings.hardwareDecode =
(await settingsManager.getSetting("hardware-decode")) ||
DEFAULT_HARDWARE_DECODE;
pluginSettings.vodQuality =
(await settingsManager.getSetting("vod-quality")) || DEFAULT_VOD_QUALITY;
pluginSettings.liveQuality =
(await settingsManager.getSetting("live-quality")) || DEFAULT_LIVE_QUALITY;
pluginSettings.hevcProfile =
(await settingsManager.getSetting("hevc-profile")) || DEFAULT_HEVC_PROFILE;
pluginSettings.cqH264 =
parseInt(await settingsManager.getSetting("cq-h264")) || DEFAULT_CQ_H264;
pluginSettings.cqHEVC =
parseInt(await settingsManager.getSetting("cq-hevc")) || DEFAULT_CQ_HEVC;
pluginSettings.h264Profile =
(await settingsManager.getSetting("h264-profile")) || DEFAULT_H264_PROFILE;
for (const [resolution, bitrate] of DEFAULT_BITRATES) {
const key = `base-bitrate-${resolution}`;
const storedValue = await settingsManager.getSetting(key);
pluginSettings.baseBitrate.set(resolution, parseInt(storedValue) || bitrate);
logger.info(`Bitrate ${printResolution(resolution)}: ${pluginSettings.baseBitrate.get(resolution)}`);
pluginSettings.baseBitrate.set(
resolution,
parseInt(storedValue) || bitrate
);
logger.info(
`Bitrate ${printResolution(resolution)}: ${pluginSettings.baseBitrate.get(
resolution
)}`
);
}
logger.info(`Hardware decode: ${pluginSettings.hardwareDecode}`);
logger.info(`VOD Quality: ${pluginSettings.vodQuality}`);
logger.info(`Live Quality: ${pluginSettings.liveQuality}`);
logger.info(`HEVC profile: ${pluginSettings.hevcProfile}`);
logger.info(`H264 profile: ${pluginSettings.h264Profile}`);
}
function printResolution(resolution) {
switch (resolution) {
case 0: return 'audio only';
case 0:
return "audio only";
case 144:
case 360:
case 480:
@ -175,21 +218,17 @@ function printResolution(resolution) {
case 1080:
case 1440:
return `${resolution}p`;
case 2160: return '4K';
default: return 'Unknown';
case 2160:
return "4K";
default:
return "Unknown";
}
}
function buildInitOptions() {
if (pluginSettings.hardwareDecode) {
return [
'-hwaccel cuda',
'-hwaccel_output_format cuda'
];
}
else {
return [
'-hwaccel cuda'
];
return ["-hwaccel cuda", "-hwaccel_output_format cuda"];
} else {
return ["-hwaccel cuda"];
}
}
@ -197,10 +236,10 @@ function buildInitOptions() {
async function vodBuilder(params) {
const { resolution, fps, streamNum, inputBitrate } = params;
const streamSuffix = streamNum == undefined ? '' : `:${streamNum}`;
const streamSuffix = streamNum == undefined ? "" : `:${streamNum}`;
let targetBitrate = getTargetBitrate(resolution, fps);
// let targetBitrate = inputBitrate;
let shouldInitVaapi = (streamNum == undefined || streamNum <= latestStreamNum);
let shouldInitVaapi = streamNum == undefined || streamNum <= latestStreamNum;
if (targetBitrate > inputBitrate) {
targetBitrate = inputBitrate;
}
@ -210,30 +249,67 @@ async function vodBuilder(params) {
}
let options = {
scaleFilter: {
name: 'scale'
name: "scale",
},
inputOptions: shouldInitVaapi ? buildInitOptions() : [],
outputOptions: [
`-preset ${pluginSettings.vodQuality}`,
`-b:v${streamSuffix} ${targetBitrate}`,
`-bufsize ${targetBitrate * 2}`,
`-profile:v${streamSuffix} high`,
`-profile:v${streamSuffix} ${pluginSettings.h264Profile}`,
`-cq ${pluginSettings.cqH264}`,
`-bf 4`
]
`-bf 4`,
],
};
logger.info(`EncoderOptions: ${JSON.stringify(options)}`);
logger.info(`EncoderOptions: ${JSON.stringify(options)}, HEVC: false`);
return options;
}
//H264 Live builder
async function liveBuilder(params) {
const { resolution, fps, streamNum, inputBitrate } = params;
const streamSuffix = streamNum == undefined ? "" : `:${streamNum}`;
let targetBitrate = getTargetBitrate(resolution, fps);
// let targetBitrate = inputBitrate;
let shouldInitVaapi = streamNum == undefined || streamNum <= latestStreamNum;
if (targetBitrate > inputBitrate) {
targetBitrate = inputBitrate;
}
logger.info(`Building encoder options, received ${JSON.stringify(params)}`);
if (shouldInitVaapi && streamNum != undefined) {
latestStreamNum = streamNum;
}
let options = {
scaleFilter: {
name: "scale",
},
inputOptions: shouldInitVaapi ? buildInitOptions() : [],
outputOptions: [
`-tune ${pluginSettings.liveQuality}`,
`-r:v${streamSuffix} ${fps}`,
`-profile:v${streamSuffix} ${pluginSettings.h264Profile}`,
`-cq ${pluginSettings.cqH264}`,
`-g:v${streamSuffix} ${fps * 2}`,
`-b:v${streamSuffix} ${targetBitrate}`,
`-bufsize ${targetBitrate * 2}`,
`-bf 4`,
],
};
logger.info(`EncoderOptions: ${JSON.stringify(options)}, HEVC: false`);
return options;
}
//HEVC VOD builder
async function hevcVODBuilder(params) {
const { resolution, fps, streamNum, inputBitrate } = params;
const streamSuffix = streamNum == undefined ? '' : `:${streamNum}`;
const streamSuffix = streamNum == undefined ? "" : `:${streamNum}`;
let targetBitrate = getTargetBitrate(resolution, fps);
// let targetBitrate = inputBitrate;
let shouldInitVaapi = (streamNum == undefined || streamNum <= latestStreamNum);
let shouldInitVaapi = streamNum == undefined || streamNum <= latestStreamNum;
if (targetBitrate > inputBitrate) {
targetBitrate = inputBitrate;
}
@ -243,7 +319,7 @@ async function hevcVODBuilder(params) {
}
let options = {
scaleFilter: {
name: 'scale'
name: "scale",
},
inputOptions: shouldInitVaapi ? buildInitOptions() : [],
outputOptions: [
@ -251,23 +327,22 @@ async function hevcVODBuilder(params) {
`-b:v${streamSuffix} ${targetBitrate}`,
`-bufsize ${targetBitrate * 2}`,
`-profile:v${streamSuffix} ${pluginSettings.hevcProfile}`,
`-cq ${pluginSettings.cqHEVC}`
]
`-cq ${pluginSettings.cqHEVC}`,
],
};
logger.info(`EncoderOptions: ${JSON.stringify(options)}`);
logger.info(`EncoderOptions: ${JSON.stringify(options)}, HEVC: true`);
return options;
}
//HEVC Live builder
async function hevcLiveBuilder(params) {
const { resolution, fps, streamNum, inputBitrate } = params;
const streamSuffix = streamNum == undefined ? '' : `:${streamNum}`;
const streamSuffix = streamNum == undefined ? "" : `:${streamNum}`;
let targetBitrate = getTargetBitrate(resolution, fps);
// let targetBitrate = inputBitrate;
let shouldInitVaapi = (streamNum == undefined || streamNum <= latestStreamNum);
let shouldInitVaapi = streamNum == undefined || streamNum <= latestStreamNum;
if (targetBitrate > inputBitrate) {
targetBitrate = inputBitrate;
}
@ -278,7 +353,7 @@ async function hevcLiveBuilder(params) {
let options = {
scaleFilter: {
name: 'scale'
name: "scale",
},
inputOptions: shouldInitVaapi ? buildInitOptions() : [],
outputOptions: [
@ -288,55 +363,21 @@ async function hevcLiveBuilder(params) {
`-g:v${streamSuffix} ${fps * 2}`,
`-b:v${streamSuffix} ${targetBitrate}`,
`-cq ${pluginSettings.cqHEVC}`,
`-bufsize ${targetBitrate * 2}`
]
};
logger.info(`EncoderOptions: ${JSON.stringify(options)}`);
return options;
}
//H264 Live builder
async function liveBuilder(params) {
const { resolution, fps, streamNum, inputBitrate } = params;
const streamSuffix = streamNum == undefined ? '' : `:${streamNum}`;
let targetBitrate = getTargetBitrate(resolution, fps);
// let targetBitrate = inputBitrate;
let shouldInitVaapi = (streamNum == undefined || streamNum <= latestStreamNum);
if (targetBitrate > inputBitrate) {
targetBitrate = inputBitrate;
}
logger.info(`Building encoder options, received ${JSON.stringify(params)}`);
if (shouldInitVaapi && streamNum != undefined) {
latestStreamNum = streamNum;
}
let options = {
scaleFilter: {
name: 'scale'
},
inputOptions: shouldInitVaapi ? buildInitOptions() : [],
outputOptions: [
`-tune ${pluginSettings.liveQuality}`,
`-r:v${streamSuffix} ${fps}`,
`-profile:v${streamSuffix} high`,
`-cq ${pluginSettings.cqH264}`,
`-g:v${streamSuffix} ${fps * 2}`,
`-b:v${streamSuffix} ${targetBitrate}`,
`-bufsize ${targetBitrate * 2}`,
`-bf 4`
]
],
};
logger.info(`EncoderOptions: ${JSON.stringify(options)}`);
logger.info(`EncoderOptions: ${JSON.stringify(options)}, HEVC: true`);
return options;
}
function getTargetBitrate(resolution, fps) {
const baseBitrate = pluginSettings.baseBitrate.get(resolution) || 0;
const maxBitrate = baseBitrate * 1.4;
const maxBitrate = baseBitrate * 1.6;
const maxBitrateDifference = maxBitrate - baseBitrate;
const maxFpsDifference = 60 - 30;
return Math.floor(baseBitrate + (fps - 30) * (maxBitrateDifference / maxFpsDifference));
return Math.floor(
baseBitrate + (fps - 30) * (maxBitrateDifference / maxFpsDifference)
);
}
//# sourceMappingURL=main.js.map

View File

@ -1,8 +1,8 @@
{
"name": "peertube-plugin-nctv-nvenc-transcode",
"version": "1.2.0",
"version": "1.2.3",
"license": "MIT",
"description": "Plugin that adds transcode profiles which use NVIDIA NVENC for hardware acceleration",
"description": "Plugin that adds transcode profiles which use h264_nvenc and hevc_nvenc for hardware acceleration.",
"engine": {
"peertube": ">=5.1.0"
},