Add Tdarr_Plugin_00td_filter_by_stream_tag

Community/Tdarr_Plugin_00td_filter_by_stream_tag.js

@@ -0,0 +1,117 @@
+const details = () => ({
+  id: 'Tdarr_Plugin_00td_filter_by_stream_tag',
+  Stage: 'Pre-processing',
+  Name: 'Filter by stream tag',
+  Type: 'Video',
+  Operation: 'Filter',
+  Description: `Filter by stream tag value. Will check all streams. Useful for when e.g. trying to force transcoding
+  from hevc to hevc. In this circumstance, newly transcoded files can have say COPYRIGHT tag set to 'processed' using
+  '-metadata:s:v:0 COPYRIGHT=processed' and this filter will then break out of the plugin stack cycling
+  after transcoding.`,
+  Version: '1.00',
+  Tags: 'filter',
+  Inputs: [
+    {
+      name: 'tagName',
+      type: 'string',
+      defaultValue: 'COPYRIGHT',
+      inputUI: {
+        type: 'text',
+      },
+      tooltip:
+        'Enter the stream tag to check',
+    },
+    {
+      name: 'tagValues',
+      type: 'string',
+      defaultValue: 'processed',
+      inputUI: {
+        type: 'text',
+      },
+      tooltip:
+        'Enter a comma separated list of tag values to check for.',
+    },
+    {
+      name: 'continueIfTagFound',
+      type: 'boolean',
+      defaultValue: false,
+      inputUI: {
+        type: 'dropdown',
+        options: [
+          false,
+          true,
+        ],
+      },
+      tooltip:
+        'Specify whether to continue the plugin stack if the tag is found.',
+    },
+  ],
+});
+
+// eslint-disable-next-line no-unused-vars
+const plugin = (file, librarySettings, inputs, otherArguments) => {
+  const lib = require('../methods/lib')();
+  // eslint-disable-next-line no-unused-vars,no-param-reassign
+  inputs = lib.loadDefaultValues(inputs, details);
+  const response = {
+    processFile: false,
+    infoLog: '',
+  };
+
+  if (inputs.tagName.trim() === '') {
+    response.infoLog += 'No input tagName entered in plugin, skipping \n';
+    return response;
+  }
+
+  const tagName = inputs.tagName.trim();
+
+  if (inputs.tagValues.trim() === '') {
+    response.infoLog += 'No input tagValues entered in plugin, skipping \n';
+    return response;
+  }
+
+  const tagValues = inputs.tagValues.trim().split(',');
+
+  let streamContainsTag = false;
+  try {
+    try {
+      for (let i = 0; i < file.ffProbeData.streams.length; i += 1) {
+        if (tagValues.includes(file.ffProbeData.streams[i]?.tags[tagName])) {
+          streamContainsTag = true;
+        }
+      }
+    } catch (err) {
+      // err
+    }
+
+    const message = `A stream with tag name ${tagName} containing ${tagValues.join(',')} has`;
+
+    if (inputs.continueIfTagFound === true) {
+      if (streamContainsTag === true) {
+        response.processFile = true;
+        response.infoLog += `${message} been found, continuing to next plugin  \n`;
+      } else {
+        response.processFile = false;
+        response.infoLog += `${message} not been found, breaking out of stack  \n`;
+      }
+    } else if (inputs.continueIfTagFound === false) {
+      if (streamContainsTag === true) {
+        response.processFile = false;
+        response.infoLog += `${message} been found, breaking out of stack  \n`;
+      } else {
+        response.processFile = true;
+        response.infoLog += `${message} not been found, continuing to next plugin \n`;
+      }
+    }
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.log(err);
+    response.infoLog += err;
+    response.processFile = false;
+  }
+
+  return response;
+};
+
+module.exports.details = details;
+module.exports.plugin = plugin;

tests/Community/Tdarr_Plugin_00td_filter_by_stream_tag.js

@@ -0,0 +1,190 @@
+/* eslint max-len: 0 */
+const _ = require('lodash');
+const run = require('../helpers/run');
+
+const tests = [
+  {
+    input: {
+      file: _.cloneDeep(require('../sampleData/media/sampleH264_2.json')),
+      librarySettings: {},
+      inputs: {},
+      otherArguments: {},
+    },
+    output: {
+      processFile: true,
+      infoLog: 'A stream with tag name COPYRIGHT containing processed has not been found, continuing to next plugin \n',
+    },
+  },
+
+  {
+    input: {
+      file: _.cloneDeep(require('../sampleData/media/sampleH264_2.json')),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'processed',
+        continueIfTagFound: false,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: true,
+      infoLog: 'A stream with tag name COPYRIGHT containing processed has not been found, continuing to next plugin \n',
+    },
+  },
+
+  {
+    input: {
+      file: (() => {
+        const file = _.cloneDeep(require('../sampleData/media/sampleH265_1.json'));
+        file.ffProbeData.streams[0].tags.COPYRIGHT = 'processed';
+        return file;
+      })(),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'processed',
+        continueIfTagFound: false,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: false,
+      infoLog: 'A stream with tag name COPYRIGHT containing processed has been found, breaking out of stack  \n',
+    },
+  },
+
+  {
+    input: {
+      file: (() => {
+        const file = _.cloneDeep(require('../sampleData/media/sampleH265_1.json'));
+        file.ffProbeData.streams[1].tags.COPYRIGHT = 'processed';
+        return file;
+      })(),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'proc,processed',
+        continueIfTagFound: false,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: false,
+      infoLog: 'A stream with tag name COPYRIGHT containing proc,processed has been found, breaking out of stack  \n',
+    },
+  },
+
+  {
+    input: {
+      file: (() => {
+        const file = _.cloneDeep(require('../sampleData/media/sampleH265_1.json'));
+        file.ffProbeData.streams[0].tags.COPYRIGHT = 'processed';
+        return file;
+      })(),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'proc,proce',
+        continueIfTagFound: false,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: true,
+      infoLog: 'A stream with tag name COPYRIGHT containing proc,proce has not been found, continuing to next plugin \n',
+    },
+  },
+
+  // continueIfTagFound: true
+
+  {
+    input: {
+      file: _.cloneDeep(require('../sampleData/media/sampleH264_2.json')),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'processed',
+        continueIfTagFound: true,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: false,
+      infoLog: 'A stream with tag name COPYRIGHT containing processed has not been found, breaking out of stack  \n',
+    },
+  },
+
+  {
+    input: {
+      file: (() => {
+        const file = _.cloneDeep(require('../sampleData/media/sampleH265_1.json'));
+        file.ffProbeData.streams[0].tags.COPYRIGHT = 'processed';
+        return file;
+      })(),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'processed',
+        continueIfTagFound: true,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: true,
+      infoLog: 'A stream with tag name COPYRIGHT containing processed has been found, continuing to next plugin  \n',
+    },
+  },
+
+  {
+    input: {
+      file: (() => {
+        const file = _.cloneDeep(require('../sampleData/media/sampleH265_1.json'));
+        file.ffProbeData.streams[1].tags.COPYRIGHT = 'processed';
+        return file;
+      })(),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'proc,processed',
+        continueIfTagFound: true,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: true,
+      infoLog: 'A stream with tag name COPYRIGHT containing proc,processed has been found, continuing to next plugin  \n',
+    },
+  },
+
+  {
+    input: {
+      file: (() => {
+        const file = _.cloneDeep(require('../sampleData/media/sampleH265_1.json'));
+        file.ffProbeData.streams[0].tags.COPYRIGHT = 'processed';
+        return file;
+      })(),
+      librarySettings: {},
+      inputs: {
+        tagName: 'COPYRIGHT',
+        tagValues: 'proc,proce',
+        continueIfTagFound: true,
+
+      },
+      otherArguments: {},
+    },
+    output: {
+      processFile: false,
+      infoLog: 'A stream with tag name COPYRIGHT containing proc,proce has not been found, breaking out of stack  \n',
+    },
+  },
+];
+
+run(tests);