Merge pull request #85 from Marnalas/flowPluginSetSubtitleDefaultStream

Added setDefaultSubtitleStream flow plugin

FlowPlugins/CommunityFlowPlugins/ffmpegCommand/ffmpegCommandSetDefaultSubtitleStream/1.0.0/index.js

@@ -0,0 +1,145 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.plugin = exports.details = void 0;
+var flowUtils_1 = require("../../../../FlowHelpers/1.0.0/interfaces/flowUtils");
+/* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
+var details = function () { return ({
+    name: 'Set Default Subtitle Stream',
+    description: 'Sets the default subtitle track based on language',
+    style: {
+        borderColor: '#6efefc',
+    },
+    tags: 'video',
+    isStartPlugin: false,
+    pType: '',
+    requiresVersion: '2.11.01',
+    sidebarPosition: -1,
+    icon: '',
+    inputs: [
+        {
+            label: 'Use Radarr or Sonarr to get original language',
+            name: 'useRadarrOrSonarr',
+            type: 'boolean',
+            defaultValue: 'false',
+            inputUI: {
+                type: 'switch',
+            },
+            tooltip: 'Should the language of the default subtitle track be read from Radarr or Sonarr ? If yes, '
+                + 'the "Set Flow Variables From Radarr Or Sonarr" has to be run before and the Language property will be '
+                + 'ignored. If no, please indicate the language to use in the Language property.',
+        },
+        {
+            label: 'Language',
+            name: 'language',
+            type: 'string',
+            defaultValue: 'eng',
+            inputUI: {
+                type: 'text',
+            },
+            tooltip: 'Specify what language to use in the ISO 639-2 format.'
+                + '\\nExample:\\n'
+                + 'eng\\n'
+                + 'fre\\n',
+        },
+    ],
+    outputs: [
+        {
+            number: 1,
+            tooltip: 'Default has been set',
+        },
+        {
+            number: 2,
+            tooltip: 'No default has been set',
+        },
+    ],
+}); };
+exports.details = details;
+var getFFMPEGDisposition = function (isDefault, dispositions) {
+    if (!dispositions)
+        return isDefault ? 'default' : '0';
+    var previousDispositions = Object.entries(dispositions)
+        .reduce(function (acc, _a) {
+        var key = _a[0], value = _a[1];
+        if (key !== 'default' && value === 1) {
+            acc.push(key);
+        }
+        return acc;
+    }, []);
+    return __spreadArray([
+        isDefault ? 'default' : ''
+    ], previousDispositions, true).filter(Boolean)
+        .join('+')
+        || '0';
+};
+var getIsDescriptiveSubtitleStream = function (stream) {
+    var _a;
+    return Boolean(stream.disposition
+        && (stream.disposition.comment
+            || stream.disposition.descriptions
+            || stream.disposition.visual_impaired
+            || /\b(commentary|description|descriptive)\b/gi.test(((_a = stream.tags) === null || _a === void 0 ? void 0 : _a.title) || '')));
+};
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+var plugin = function (args) {
+    var lib = require('../../../../../methods/lib')();
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
+    args.inputs = lib.loadDefaultValues(args.inputs, details);
+    (0, flowUtils_1.checkFfmpegCommandInit)(args);
+    // const streams: IffmpegCommandStream[] = JSON.parse(JSON.stringify(args.variables.ffmpegCommand.streams));
+    var streams = args.variables.ffmpegCommand.streams;
+    var shouldProcess = false;
+    var defaultSet = false;
+    // Sets the language code used to determine the default subtitle stream
+    var languageCode = args.inputs.language;
+    if (args.inputs.useRadarrOrSonarr) {
+        languageCode = args.variables.user.ArrOriginalLanguageCode;
+        args.jobLog("Language ".concat(languageCode, " read from flow variables"));
+    }
+    streams.forEach(function (stream, index) {
+        var _a, _b, _c, _d, _e, _f;
+        if (stream.codec_type === 'subtitle') {
+            var dispositions = stream.disposition;
+            var isDescriptiveSubtitleStream = getIsDescriptiveSubtitleStream(stream);
+            if (((_b = (_a = stream.tags) === null || _a === void 0 ? void 0 : _a.language) !== null && _b !== void 0 ? _b : '') === languageCode
+                && ((_c = dispositions === null || dispositions === void 0 ? void 0 : dispositions.default) !== null && _c !== void 0 ? _c : 0) === 0
+                && !isDescriptiveSubtitleStream
+                && !defaultSet) {
+                args.jobLog("Stream ".concat(index, " (language ").concat(languageCode, ") set has default"));
+                stream.outputArgs.push("-c:".concat(index), 'copy', "-disposition:".concat(index), getFFMPEGDisposition(true, dispositions));
+                defaultSet = true;
+                shouldProcess = true;
+            }
+            else if (((_d = dispositions === null || dispositions === void 0 ? void 0 : dispositions.default) !== null && _d !== void 0 ? _d : 0) === 1
+                && (((_f = (_e = stream.tags) === null || _e === void 0 ? void 0 : _e.language) !== null && _f !== void 0 ? _f : '') !== languageCode
+                    || isDescriptiveSubtitleStream)) {
+                args.jobLog("Stream ".concat(index, " (language ").concat(languageCode, ", descriptive ").concat(isDescriptiveSubtitleStream, ") ")
+                    + 'set has not default');
+                stream.outputArgs.push("-c:".concat(index), 'copy', "-disposition:".concat(index), getFFMPEGDisposition(false, dispositions));
+                shouldProcess = true;
+            }
+        }
+    });
+    if (shouldProcess) {
+        // eslint-disable-next-line no-param-reassign
+        args.variables.ffmpegCommand.shouldProcess = true;
+        // eslint-disable-next-line no-param-reassign
+        args.variables.ffmpegCommand.streams = streams;
+    }
+    else
+        args.jobLog('No stream to modify');
+    return {
+        outputFileObj: args.inputFileObj,
+        outputNumber: shouldProcess ? 1 : 2,
+        variables: args.variables,
+    };
+};
+exports.plugin = plugin;

FlowPluginsTs/CommunityFlowPlugins/ffmpegCommand/ffmpegCommandSetDefaultSubtitleStream/1.0.0/index.ts

@@ -0,0 +1,181 @@
+import { checkFfmpegCommandInit } from '../../../../FlowHelpers/1.0.0/interfaces/flowUtils';
+import {
+  IpluginDetails,
+  IpluginInputArgs,
+  IpluginOutputArgs,
+} from '../../../../FlowHelpers/1.0.0/interfaces/interfaces';
+
+/* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
+const details = (): IpluginDetails => ({
+  name: 'Set Default Subtitle Stream',
+  description: 'Sets the default subtitle track based on language',
+  style: {
+    borderColor: '#6efefc',
+  },
+  tags: 'video',
+  isStartPlugin: false,
+  pType: '',
+  requiresVersion: '2.11.01',
+  sidebarPosition: -1,
+  icon: '',
+  inputs: [
+    {
+      label: 'Use Radarr or Sonarr to get original language',
+      name: 'useRadarrOrSonarr',
+      type: 'boolean',
+      defaultValue: 'false',
+      inputUI: {
+        type: 'switch',
+      },
+      tooltip: 'Should the language of the default subtitle track be read from Radarr or Sonarr ? If yes, '
+        + 'the "Set Flow Variables From Radarr Or Sonarr" has to be run before and the Language property will be '
+        + 'ignored. If no, please indicate the language to use in the Language property.',
+    },
+    {
+      label: 'Language',
+      name: 'language',
+      type: 'string',
+      defaultValue: 'eng',
+      inputUI: {
+        type: 'text',
+      },
+      tooltip: 'Specify what language to use in the ISO 639-2 format.'
+        + '\\nExample:\\n'
+        + 'eng\\n'
+        + 'fre\\n',
+    },
+  ],
+  outputs: [
+    {
+      number: 1,
+      tooltip: 'Default has been set',
+    },
+    {
+      number: 2,
+      tooltip: 'No default has been set',
+    },
+  ],
+});
+
+interface IDisposition {
+  default: number,
+  dub: number,
+  original: number,
+  comment: number,
+  lyrics: number,
+  karaoke: number,
+  forced: number,
+  hearing_impaired: number,
+  visual_impaired: number,
+  clean_effects: number,
+  attached_pic: number,
+  timed_thumbnails: number,
+  captions: number,
+  descriptions: number,
+  metadata: number,
+  dependent: number,
+  still_image: number,
+}
+
+interface IStreamDisposition {
+  disposition?: IDisposition
+  tags?: { title?: string }
+}
+
+const getFFMPEGDisposition = (isDefault: boolean, dispositions?: IDisposition): string => {
+  if (!dispositions) return isDefault ? 'default' : '0';
+
+  const previousDispositions = Object.entries(dispositions)
+    .reduce((acc, [key, value]) => {
+      if (key !== 'default' && value === 1) {
+        acc.push(key);
+      }
+      return acc;
+    }, [] as string[]);
+
+  return [
+    isDefault ? 'default' : '',
+    ...previousDispositions,
+  ]
+    .filter(Boolean)
+    .join('+')
+    || '0';
+};
+
+const getIsDescriptiveSubtitleStream = (stream: IStreamDisposition): boolean => Boolean(stream.disposition
+  && (stream.disposition.comment
+    || stream.disposition.descriptions
+    || stream.disposition.visual_impaired
+    || /\b(commentary|description|descriptive)\b/gi.test(stream.tags?.title || '')));
+
+// 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);
+
+  checkFfmpegCommandInit(args);
+
+  // const streams: IffmpegCommandStream[] = JSON.parse(JSON.stringify(args.variables.ffmpegCommand.streams));
+  const { streams } = args.variables.ffmpegCommand;
+
+  let shouldProcess = false;
+  let defaultSet = false;
+
+  // Sets the language code used to determine the default subtitle stream
+  let languageCode = args.inputs.language;
+  if (args.inputs.useRadarrOrSonarr) {
+    languageCode = args.variables.user.ArrOriginalLanguageCode;
+    args.jobLog(`Language ${languageCode} read from flow variables`);
+  }
+
+  streams.forEach((stream, index) => {
+    if (stream.codec_type === 'subtitle') {
+      const dispositions = (stream as IStreamDisposition).disposition;
+      const isDescriptiveSubtitleStream = getIsDescriptiveSubtitleStream(stream as IStreamDisposition);
+      if ((stream.tags?.language ?? '') === languageCode
+        && (dispositions?.default ?? 0) === 0
+        && !isDescriptiveSubtitleStream
+        && !defaultSet) {
+        args.jobLog(`Stream ${index} (language ${languageCode}) set has default`);
+        stream.outputArgs.push(
+          `-c:${index}`,
+          'copy',
+          `-disposition:${index}`,
+          getFFMPEGDisposition(true, dispositions),
+        );
+        defaultSet = true;
+        shouldProcess = true;
+      } else if ((dispositions?.default ?? 0) === 1
+        && ((stream.tags?.language ?? '') !== languageCode
+        || isDescriptiveSubtitleStream)) {
+        args.jobLog(`Stream ${index} (language ${languageCode}, descriptive ${isDescriptiveSubtitleStream}) `
+          + 'set has not default');
+        stream.outputArgs.push(
+          `-c:${index}`,
+          'copy',
+          `-disposition:${index}`,
+          getFFMPEGDisposition(false, dispositions),
+        );
+        shouldProcess = true;
+      }
+    }
+  });
+
+  if (shouldProcess) {
+    // eslint-disable-next-line no-param-reassign
+    args.variables.ffmpegCommand.shouldProcess = true;
+    // eslint-disable-next-line no-param-reassign
+    args.variables.ffmpegCommand.streams = streams;
+  } else args.jobLog('No stream to modify');
+
+  return {
+    outputFileObj: args.inputFileObj,
+    outputNumber: shouldProcess ? 1 : 2,
+    variables: args.variables,
+  };
+};
+export {
+  details,
+  plugin,
+};