gabehf/Tdarr_Plugins
1
0
Fork 0
mirror of https://github.com/gabehf/Tdarr_Plugins.git synced 2026-03-09 07:29:04 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Compare File Size Ratio Live

Browse source
This commit is contained in:
HaveAGitGat 2024-06-12 07:47:05 +01:00
parent 6d6ff0bb88
commit 9ac675d401
14 changed files with 265 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

2
FlowPluginsTs/CommunityFlowPlugins/audio/normalizeAudio/1.0.0/index.ts
View file

@ -99,6 +99,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();
@ -160,6 +161,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res2 = await cli2.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/basic/basicVideoOrAudio/1.0.0/index.ts
View file

@ -356,6 +356,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/classic/runClassicTranscodePlugin/1.0.0/index.ts
View file

@ -182,6 +182,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/classic/runClassicTranscodePlugin/2.0.0/index.ts
View file

@ -187,6 +187,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/ffmpegCommand/ffmpegCommandExecute/1.0.0/index.ts
View file

@ -168,6 +168,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

167
FlowPluginsTs/CommunityFlowPlugins/file/compareFileSizeRatioLive/1.0.0/index.ts Normal file
View file

@ -0,0 +1,167 @@
import {
IpluginDetails,
IpluginInputArgs,
IpluginOutputArgs,
} from '../../../../FlowHelpers/1.0.0/interfaces/interfaces';
/* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
const details = (): IpluginDetails => ({
name: 'Compare File Size Ratio Live',
description: `
Compare either the estimated final size or current output size to the input size and
give an error if estimated final size or current size surpasses the threshold %.
Works with 'FfmpegCommand', 'HandBrake Custom Arguments', 'Run Classic Transcode' and other flow plugins
that output a file.
Can be placed anywhere before a plugin which outputs a new file.
',
`,
style: {
borderColor: 'orange',
},
tags: '',
isStartPlugin: false,
pType: '',
requiresVersion: '2.11.01',
sidebarPosition: -1,
icon: 'faQuestion',
inputs: [
{
label: 'Enabled',
name: 'enabled',
type: 'boolean',
defaultValue: 'true',
inputUI: {
type: 'switch',
},
tooltip: 'Enable or disable this plugin. For example you may want to enable it for one set of transcoding tests.',
},
{
label: 'Compare Method',
name: 'compareMethod',
type: 'string',
defaultValue: 'estimatedFinalSize',
inputUI: {
type: 'dropdown',
options: [
'estimatedFinalSize',
'currentSize',
],
displayConditions: {
logic: 'AND',
sets: [
{
logic: 'AND',
inputs: [
{
name: 'enabled',
value: 'true',
condition: '===',
},
],
},
],
},
},
tooltip: `Specify the method to compare.
Estimated Final Size: Compare the estimated final output size to the input size.
Current Size: Compare the current output size to the input size.
`,
},
{
label: 'Threshold Size %',
name: 'thresholdPerc',
type: 'number',
defaultValue: '60',
inputUI: {
type: 'text',
displayConditions: {
logic: 'AND',
sets: [
{
logic: 'AND',
inputs: [
{
name: 'enabled',
value: 'true',
condition: '===',
},
],
},
],
},
},
tooltip: `Enter the threshold size percentage relative to the input size.
An error will be triggered if the estimated or current size exceeds this percentage.
For example, if the input size is 100MB and the threshold is 60%, the estimated final size or current size
must not surpass 60MB else an error will be given and processing will stop.
`,
},
{
label: 'Check Delay (seconds)',
name: 'checkDelaySeconds',
type: 'number',
defaultValue: '20',
inputUI: {
type: 'text',
displayConditions: {
logic: 'AND',
sets: [
{
logic: 'AND',
inputs: [
{
name: 'enabled',
value: 'true',
condition: '===',
},
],
},
],
},
},
tooltip: `
Specify the delay in seconds before beginning the comparison.
A larger delay gives more time for the estimated final size to stabilize.
`,
},
],
outputs: [
{
number: 1,
tooltip: 'Continue to next plugin',
},
],
});
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const plugin = (args: IpluginInputArgs):IpluginOutputArgs => {
const lib = require('../../../../../methods/lib')();
// eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
args.inputs = lib.loadDefaultValues(args.inputs, details);
const enabled = Boolean(args.inputs.enabled);
const compareMethod = String(args.inputs.compareMethod);
const thresholdPerc = Number(args.inputs.thresholdPerc);
const checkDelaySeconds = Number(args.inputs.checkDelaySeconds);
// eslint-disable-next-line no-param-reassign
args.variables.liveSizeCompare = {
enabled,
compareMethod,
thresholdPerc,
checkDelaySeconds,
};
return {
outputFileObj: args.inputFileObj,
outputNumber: 1,
variables: args.variables,
};
};
export {
details,
plugin,
};

1
FlowPluginsTs/CommunityFlowPlugins/handbrake/handbrakeCustomArguments/1.0.0/index.ts
View file

@ -122,6 +122,7 @@ const plugin = async (args:IpluginInputArgs):Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/handbrake/handbrakeCustomArguments/2.0.0/index.ts
View file

@ -165,6 +165,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

3
FlowPluginsTs/CommunityFlowPlugins/tools/apprise/1.0.0/index.ts
View file

@ -15,7 +15,7 @@ const details = ():IpluginDetails => ({
tags: '',
isStartPlugin: false,
pType: '',
requiresVersion: '2.11.01',
requiresVersion: '2.18.01',
sidebarPosition: -1,
icon: 'faBell',
inputs: [
@ -71,6 +71,7 @@ const plugin = async (args:IpluginInputArgs):Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/tools/runCli/1.0.0/index.ts
View file

@ -251,6 +251,7 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/tools/runMkvPropEdit/1.0.0/index.ts
View file

@ -48,6 +48,7 @@ const plugin = async (args:IpluginInputArgs):Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

1
FlowPluginsTs/CommunityFlowPlugins/video/runHealthCheck/1.0.0/index.ts
View file

@ -93,6 +93,7 @@ const plugin = async (args:IpluginInputArgs):Promise<IpluginOutputArgs> => {
inputFileObj: args.inputFileObj,
logFullCliOutput: args.logFullCliOutput,
updateWorker: args.updateWorker,
args,
});
const res = await cli.runCli();

94
FlowPluginsTs/FlowHelpers/1.0.0/cliUtils.ts
View file

@ -2,7 +2,7 @@ import fs from 'fs';
import {
editreadyParser, ffmpegParser, getHandBrakeFps, handbrakeParser,
} from './cliParsers';
import { Ilog, IupdateWorker } from './interfaces/interfaces';
import { Ilog, IpluginInputArgs, IupdateWorker } from './interfaces/interfaces';
import { IFileObject, Istreams } from './interfaces/synced/IFileObject';
import { fileExists } from './fileUtils';
@ -71,6 +71,7 @@ interface Iconfig {
updateWorker: IupdateWorker,
logFullCliOutput: boolean,
inputFileObj: IFileObject,
args: IpluginInputArgs,
}
class CLI {
@ -89,6 +90,13 @@ class CLI {
hbPass = 0;
// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/explicit-module-boundary-types
thread: any;
cancelled = false;
startTime = new Date().getTime();
constructor(config: Iconfig) {
this.config = config;
}
@ -156,6 +164,58 @@ class CLI {
this.lastProgCheck = n;
this.oldProgress = perc;
const secondsSinceStart = (new Date().getTime() - this.startTime) / 1000;
// live size compare
if (
this.config.args.variables.liveSizeCompare?.enabled
) {
const {
compareMethod,
thresholdPerc,
checkDelaySeconds,
} = this.config.args.variables.liveSizeCompare;
if (secondsSinceStart > checkDelaySeconds) {
// MB
const inputFileSize = this.config.inputFileObj.file_size;
const inputFileSizeInGbytes = inputFileSize / 1024;
const cancel = (ratio:number) => {
this.config.jobLog(`Input file size: ${inputFileSizeInGbytes}GB`);
this.config.jobLog(`Ratio: ${ratio}%`);
this.config.jobLog(`Ratio is greater than threshold: ${thresholdPerc}%, cancelling job`);
this.cancelled = true;
this.killThread();
};
if (
compareMethod === 'estimatedFinalSize'
&& estSize !== undefined
&& estSize > 0
) {
const ratio = (estSize / inputFileSizeInGbytes) * 100;
if (ratio > thresholdPerc) {
this.config.jobLog(`Estimated final size: ${estSize}GB`);
cancel(ratio);
}
} else if (
compareMethod === 'currentSize'
&& outputFileSizeInGbytes !== undefined
&& outputFileSizeInGbytes > 0
) {
const ratio = (outputFileSizeInGbytes / inputFileSizeInGbytes) * 100;
if (ratio > thresholdPerc) {
this.config.jobLog(`Current output size: ${outputFileSizeInGbytes}GB`);
cancel(ratio);
}
}
}
}
}
}
}
@ -255,8 +315,7 @@ class CLI {
}
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/explicit-module-boundary-types
killThread = (thread:any): void => {
killThread = (): void => {
const killArray = [
'SIGKILL',
'SIGHUP',
@ -265,14 +324,14 @@ class CLI {
];
try {
thread.kill();
this.thread.kill();
} catch (err) {
// err
}
killArray.forEach((com: string) => {
try {
thread.kill(com);
this.thread.kill(com);
} catch (err) {
// err
}
@ -289,15 +348,12 @@ class CLI {
this.config.jobLog(`Running ${this.config.cli} ${this.config.spawnArgs.join(' ')}`);
// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/explicit-module-boundary-types
let thread: any;
const exitHandler = () => {
if (thread) {
if (this.thread) {
try {
// eslint-disable-next-line no-console
console.log('Main thread exiting, cleaning up running CLI');
this.killThread(thread);
this.killThread();
} catch (err) {
// eslint-disable-next-line no-console
console.log('Error running cliUtils on Exit function');
@ -309,24 +365,24 @@ class CLI {
process.on('exit', exitHandler);
const cliExitCode: number = await new Promise((resolve) => {
let cliExitCode: number = await new Promise((resolve) => {
try {
const opts = this.config.spawnOpts || {};
const spawnArgs = this.config.spawnArgs.map((row) => row.trim()).filter((row) => row !== '');
thread = childProcess.spawn(this.config.cli, spawnArgs, opts);
this.thread = childProcess.spawn(this.config.cli, spawnArgs, opts);
thread.stdout.on('data', (data: string) => {
this.thread.stdout.on('data', (data: string) => {
errorLogFull.push(data.toString());
this.parseOutput(data);
});
thread.stderr.on('data', (data: string) => {
this.thread.stderr.on('data', (data: string) => {
// eslint-disable-next-line no-console
errorLogFull.push(data.toString());
this.parseOutput(data);
});
thread.on('error', () => {
this.thread.on('error', () => {
// catches execution error (bad file)
// eslint-disable-next-line no-console
console.log(`Error executing binary: ${this.config.cli}`);
@ -336,7 +392,7 @@ class CLI {
// thread.stdout.pipe(process.stdout);
// thread.stderr.pipe(process.stderr);
thread.on('close', (code: number) => {
this.thread.on('close', (code: number) => {
if (code !== 0) {
// eslint-disable-next-line no-console
console.log(`CLI error code: ${code}`);
@ -355,12 +411,16 @@ class CLI {
process.removeListener('exit', exitHandler);
thread = undefined;
this.thread = undefined;
if (!this.config.logFullCliOutput) {
this.config.jobLog(errorLogFull.slice(-1000).join(''));
}
if (this.cancelled) {
cliExitCode = 1;
}
return {
cliExitCode,
errorLogFull,

8
FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces.ts
View file

@ -96,12 +96,20 @@ export interface IffmpegCommand {
overallOuputArguments: string[],
}
export interface IliveSizeCompare {
enabled: boolean,
compareMethod: string,
thresholdPerc: number,
checkDelaySeconds: number,
}
export interface Ivariables {
ffmpegCommand: IffmpegCommand,
flowFailed: boolean,
user: Record<string, string>,
healthCheck?: 'Success',
queueTags?: string,
liveSizeCompare?: IliveSizeCompare
}
export interface IpluginOutputArgs {