@pixwel/pixwel-sdk 1.1.0

package/dist/src/Ass.js

@@ -0,0 +1,200 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+var _lodash = require('lodash');
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+var _TimeFormat = require('./TimeFormat');
+
+var _TimeFormat2 = _interopRequireDefault(_TimeFormat);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function trim(str) {
+    return str.replace(/^\s+|\s+$/g, '');
+}
+
+function searchIndex(lines, pattern, startIndex) {
+    var len = lines.length;
+    startIndex = startIndex || 0;
+
+    for (var i = startIndex; i < len; i++) {
+        var line = lines[i];
+        if (line.match(pattern)) {
+            return i;
+        }
+    }
+    return false;
+}
+
+function extractStyles(lines) {
+    var line,
+        styles = {};
+
+    var currentIndex = searchIndex(lines, /^\[V4\+ Styles\]$/);
+
+    if (currentIndex === false) {
+        return styles;
+    }
+
+    currentIndex = searchIndex(lines, /^Format:/, ++currentIndex);
+
+    if (currentIndex === false) {
+        return styles;
+    }
+
+    line = trim(lines[currentIndex]);
+    var fields = line.replace(/^Format:\s+/, '').split(/\s*,\s*/);
+    var nameIndex = fields.indexOf('Name');
+    var alignmentIndex = fields.indexOf('Alignment');
+
+    if (nameIndex === -1) {
+        return styles;
+    }
+
+    var pattern = new RegExp('^' + new Array(fields.length).join('\s*(.*?)\s*,') + '(.*?)$');
+
+    currentIndex = searchIndex(lines, /^Style:/, ++currentIndex);
+
+    while (currentIndex !== false) {
+        line = trim(lines[currentIndex]);
+
+        var parts = line.replace(/^Style:\s+/, '').match(pattern);
+        if (!parts) {
+            throw new Error('Error, missing fields in a `Style` entry');
+        }
+        if (parts.length) {
+            var style = {};
+            if (alignmentIndex !== -1) {
+                var alignmentNumber = parts[alignmentIndex + 1];
+                style.alignment = alignmentNumber >= 7 ? 'top' : 'bottom';
+            }
+            styles[parts[nameIndex + 1]] = style;
+        }
+        currentIndex = searchIndex(lines, /^Style:/, ++currentIndex);
+    }
+    return styles;
+}
+
+exports.default = {
+    parse: function parse(lines) {
+        var line;
+        var currentIndex = 0;
+
+        function normalizeTime(time) {
+            if (time.charAt(1) === ':') {
+                time = '0' + time;
+            }
+            return time.replace('.', ',') + '0';
+        }
+
+        function normalizeText(text) {
+            return text.replace(/\\n|\\N/, '\n').replace(/{\\(.*)1}(.*){\\\1[0]}/g, function (match, tag, content) {
+                return '<' + tag + '>' + content + '</' + tag + '>';
+            });
+        }
+
+        var styles = extractStyles(lines);
+
+        currentIndex = searchIndex(lines, /^\[Events\]$/);
+
+        if (currentIndex === false) {
+            throw new Error('Error, missing `[Events]` section');
+        }
+
+        currentIndex = searchIndex(lines, /^Format:/, ++currentIndex);
+
+        if (currentIndex === false) {
+            throw new Error('Error, missing `Format` entry');
+        }
+
+        line = trim(lines[currentIndex]);
+        var fields = line.replace(/^Format:\s+/, '').split(/\s*,\s*/);
+        var startIndex = fields.indexOf('Start');
+        var endIndex = fields.indexOf('End');
+        var styleIndex = fields.indexOf('Style');
+        var textIndex = fields.indexOf('Text');
+
+        if (startIndex === -1 || endIndex === -1 || textIndex === -1) {
+            throw new Error('Error, missing fields in a `Format` entry');
+        }
+
+        var result = [];
+        var pattern = new RegExp('^' + new Array(fields.length).join('\s*(.*?)\s*,') + '(.*?)$');
+
+        currentIndex = searchIndex(lines, /^Dialogue:/, ++currentIndex);
+
+        while (currentIndex !== false) {
+            line = trim(lines[currentIndex]);
+            var parts = line.replace(/^Dialogue:\s+/, '').match(pattern);
+            if (!parts) {
+                throw new Error('Error, missing fields in a `Dialogue` entry');
+            }
+            if (parts.length) {
+                var entry = {
+                    startTime: normalizeTime(parts[startIndex + 1]),
+                    stopTime: normalizeTime(parts[endIndex + 1]),
+                    text: normalizeText(parts[textIndex + 1]),
+                    alignment: 'bottom'
+                };
+                if (styleIndex !== -1) {
+                    var style = styles[parts[styleIndex + 1]];
+                    if (style && style.alignment) {
+                        entry.alignment = style.alignment;
+                    }
+                }
+                result.push(entry);
+            }
+            currentIndex = searchIndex(lines, /^Dialogue:/, ++currentIndex);
+        }
+        return result;
+    },
+    export: function _export(lines, options) {
+        var result = '';
+
+        options = options || {};
+
+        var font = options.font || {
+            face: 'Arial',
+            size: 20
+        };
+
+        result += "[Script Info]\n";
+        result += "ScriptType: v4.00+\n\n";
+
+        result += "[V4+ Styles]\n";
+        result += "Format: Name, Fontname, Fontsize, PrimaryColour,Shadow,MarginV,Alignment\n";
+        result += "Style: Bottom," + font.face + "," + font.size + ",&H00FFFFFF,1,20,2\n";
+        result += "Style: Top," + font.face + "," + font.size + ",&H00FFFFFF,1,20,8\n\n";
+
+        result += "[Events]\n";
+        result += "Format: Layer, Start, End, Style, Text\n";
+
+        function normalizeTime(time) {
+            if (time.charAt(0) === '0') {
+                time = time.substr(1);
+            }
+            return time.replace(',', '.').slice(0, -1);
+        }
+
+        function normalizeText(text) {
+            return _lodash2.default.unescape(text.replace(/<div>/g, '\\N').replace(/<\/div>/g, '').replace(/\n/g, '\\N').replace(/<br>/g, '\\N').replace(/<i>/g, '{\\i1}').replace(/<\/i>/g, '{\\i0}').replace(/<b>/g, '{\\b1}').replace(/<\/b>/g, '{\\b0}'));
+        }
+
+        lines.forEach(function (line) {
+            if (line.text === undefined) {
+                return;
+            }
+            result += "Dialogue: 0";
+            result += "," + normalizeTime(_TimeFormat2.default.startTime(line));
+            result += "," + normalizeTime(_TimeFormat2.default.stopTime(line));
+            result += line.alignment === 'top' ? ",Top" : ",Bottom";
+            result += "," + normalizeText(line.text) + "\n";
+        });
+        return result;
+    }
+};

package/dist/src/Asset.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+	value: true
+});
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var Asset = function () {
+	function Asset() {
+		_classCallCheck(this, Asset);
+	}
+
+	_createClass(Asset, null, [{
+		key: "mapFromOrder",
+		value: function mapFromOrder(order) {
+			if (!order) {
+				throw new Error("missing order");
+			}
+			if (!order.asset) {
+				throw new Error("missing order.asset");
+			}
+			if (!order.project) {
+				throw new Error("missing order.project");
+			}
+			if (!order.project.slug) {
+				throw new Error("missing order.project.slug");
+			}
+			var asset = order.asset;
+			asset.project = order.project;
+			asset.project.filePrefix = order.project.slug.toUpperCase();
+			return asset;
+		}
+	}]);
+
+	return Asset;
+}();
+
+exports.default = Asset;

package/dist/src/Filename.js

@@ -0,0 +1,252 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+	value: true
+});
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+var _lodash = require("lodash");
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+/**
+ * The Filename class parses a filename into tokens, and can also take a set of
+ * tokens and create a valid Pixwel filename.
+ * @type class
+ */
+var Filename = function () {
+	function Filename() {
+		_classCallCheck(this, Filename);
+	}
+
+	_createClass(Filename, null, [{
+		key: "render",
+
+		/**
+   * Renders a valid filename given all tags, all types, an asset, and metadata
+   * options likely parsed from the file itself.
+   * @param  {Array}  [allTags=[]]  Collection of all known tags
+   * @param  {Array}  [allTypes=[]] Collection of all known types
+   * @param  {Object} [asset={}]    A Platform Asset
+   * @param  {Object} [options={}] options containing metadata about file
+   * @param  {String} [mediaType=''] Indicates video, audio, image and allows for stricter required fields
+   * @return {String}               A valid filename
+   */
+		value: function render() {
+			var allTags = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+			var allTypes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+			var asset = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+			var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+			var mediaType = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : "";
+
+			if (!asset.project) {
+				throw "missing asset.project";
+			}
+
+			if (asset.project && !asset.project.filePrefix) {
+				throw "missing asset.project.filePrefix";
+			}
+
+			if (!asset.name) {
+				throw "missing asset.name";
+			}
+
+			if (!asset.type) {
+				throw "missing asset.type";
+			}
+
+			if (asset.type.match(/^film-clip|^featurette/) && !asset.length) {
+				throw "missing asset.length";
+			}
+
+			var defaults = {
+				language: null,
+				country: null,
+				version: null,
+				tags: {
+					Usage: null,
+					Aspect: null,
+					SubDub: {
+						sub: null,
+						dub: null
+					},
+					Resolution: null,
+					"Frame Mode": null,
+					Framerate: null,
+					Text: null,
+					Codec: null,
+					Extra: []
+				}
+			};
+			options = _lodash2.default.merge(defaults, options);
+
+			if (!options.language) {
+				throw "missing options.language";
+			}
+
+			if (!options.tags.SubDub.sub && !options.tags.SubDub.dub && !options.tags.Text) {
+				throw "missing options.tags.Text or options.tags.SubDub";
+			}
+
+			if (mediaType && mediaType == "video" && !options.tags.Codec) {
+				throw "missing options.tags.Codec";
+			}
+
+			if (mediaType && mediaType == "video" && !options.tags.Resolution) {
+				throw "missing options.tags.Resolution";
+			}
+
+			if (mediaType && mediaType == "video" && !options.tags.Framerate) {
+				throw "missing options.tags.Framerate";
+			}
+
+			if (mediaType == "video" && !options.tags["Frame Mode"]) {
+				throw "missing options.tags[Frame Mode]";
+			}
+
+			// currently, slurpee's filename.ts will render this, but we can add this back in later when
+			// filename.ts starts to rely on Filename.render
+			// if ((options.tags.SubDub.dub || options.tags.SubDub.sub) && options.tags.Text) {
+			//     throw 'conflicting options supplied: SubDub and Text';
+			// }
+
+			function assetType(asset, types) {
+				if (/trailer/.test(asset.type)) {
+					return false;
+				}
+
+				var matchingType = _lodash2.default.find(types, { name: asset.type });
+				if (!matchingType) {
+					throw "Asset type \"" + asset.type + "\" could not be found";
+				}
+
+				return matchingType.file || matchingType.name.replace(".", "-").toUpperCase();
+			}
+
+			function assetTitle(asset) {
+				var prefix = "";
+				var name = asset.slug.toUpperCase().replace("INT-L", "INTL");
+				if (/trailer/.test(asset.type)) {
+					switch (asset.type) {
+						case "trailer.intl":
+							prefix = "ITR-";
+							name = name.replace(/INTL-TRAILER-/, "");
+							break;
+						case "trailer":
+							prefix = "TR-";
+							name = name.replace(/TRAILER-/, "");
+							break;
+						case "trailer.us":
+							prefix = "DTR-";
+							name = name.replace(/DOMESTIC-TRAILER-/, "");
+							break;
+					}
+				}
+				return prefix + name;
+			}
+
+			function runningTime(asset) {
+				var matches = asset.type.match(/^film-clip|^featurette/);
+				if (!matches) {
+					return;
+				}
+
+				var minutes = Math.floor(asset.length / 60);
+				var seconds = asset.length % 60;
+
+				var result = "";
+
+				if (minutes > 0) {
+					result += minutes + "min";
+				}
+
+				if (seconds > 0) {
+					result += seconds + "sec";
+				}
+
+				return result;
+			}
+
+			function locale(country, language) {
+				return [language, country].filter(function (str) {
+					return !!str && str !== "WW";
+				}).join("-");
+			}
+
+			function textType(subDub, text) {
+				if (!subDub || !subDub.sub && !subDub.dub) {
+					return text;
+				}
+
+				var result = [];
+				if (subDub.sub) {
+					result.push("sub");
+				}
+
+				if (subDub.dub) {
+					result.push("dub");
+				}
+
+				return result;
+			}
+
+			function matchSet(allTags, tags) {
+				var selectedTags = (0, _lodash2.default)(tags).values().flatten().value();
+
+				var setTag = (0, _lodash2.default)(allTags).filter("set").find(function (setTag) {
+					return _lodash2.default.difference(setTag.set, selectedTags).length === 0;
+				});
+
+				if (setTag) {
+					return setTag.name;
+				}
+			}
+
+			var tags = options.tags,
+			    parts = [asset.project.filePrefix, assetType(asset, allTypes), assetTitle(asset), runningTime(asset), locale(options.country, options.language), textType(tags.SubDub, tags.Text), tags.Extra.join("_"), options.version, tags.Codec];
+
+			parts = (0, _lodash2.default)(parts).flatten().filter().map(function (part) {
+				return part.toUpperCase();
+			});
+
+			var matchedSet = matchSet(allTags, options.tags);
+			var requiredInfo = tags.Resolution && tags["Frame Mode"] && tags.Framerate;
+
+			if (matchedSet) {
+				parts = parts.push(matchedSet);
+			} else if (mediaType == "video" && tags.Resolution && !requiredInfo) {
+				parts = parts.push(tags.Resolution.replace(/\d+x/, ""));
+			} else if (mediaType == "image" && tags.Resolution) {
+				parts = parts.push(tags.Resolution);
+			}
+
+			var name = parts.join("_");
+
+			var hasResInfo = name.match(/\d+(i|p)/i);
+			var hasAllInfo = name.match(/\d+(i|p)\d+/i);
+
+			if (requiredInfo && !hasResInfo && !hasAllInfo) {
+				var res = tags.Resolution;
+				var encodeTag = [hasResInfo ? "" : res.indexOf("x") ? res.replace(/\d+x/, "") : res, res.match(/i|p/i) && !hasResInfo ? "" : tags["Frame Mode"].toLowerCase().slice(0, 1), tags.Framerate.replace(".", "").toUpperCase()].filter(function (val) {
+					return val;
+				}).join("");
+
+				var match = new RegExp(encodeTag, "i");
+				name = name.match(match) ? name.replace(match, encodeTag) : name + "_" + encodeTag;
+			} else if (hasResInfo && !hasAllInfo && tags.Framerate) {
+				name += tags.Framerate.replace(".", "").toUpperCase();
+			}
+
+			return name;
+		}
+	}]);
+
+	return Filename;
+}();
+
+exports.default = Filename;

package/dist/src/Ingest.js

@@ -0,0 +1,200 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+	value: true
+});
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+var _lodash = require("lodash");
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+/**
+ * [media description]
+ * @type {[type]}
+ */
+var Ingest = function () {
+	function Ingest() {
+		_classCallCheck(this, Ingest);
+	}
+
+	_createClass(Ingest, null, [{
+		key: "mapMetaToTags",
+
+		/**
+   * [mapMetaToTags description]
+   * @param  {[type]} info [description]
+   * @return {[type]}      [description]
+   */
+		value: function mapMetaToTags(info, mediaType) {
+
+			var tags = {
+				Aspect: "",
+				Standard: "",
+				Resolution: "",
+				Codec: "",
+				"Frame Mode": "",
+				Text: "",
+				Usage: "",
+				Extra: [],
+				Framerate: "",
+				Duration: ""
+			};
+
+			switch (mediaType) {
+				case 'video':
+					mediaType = 'Video';
+					break;
+				case 'image':
+					mediaType = 'Image';
+					break;
+				default:
+					return tags;
+			}
+
+			if (!info.File) {
+				throw "missing info.File";
+			}
+
+			if (!info.File.track) {
+				throw "missing info.File.track";
+			}
+
+			var mediainfoDefaults = {
+				Display_aspect_ratio: "",
+				Format: "",
+				Standard: "",
+				Height: "",
+				Width: "",
+				Frame_rate: "",
+				Scan_type: ""
+			};
+
+			var media = _lodash2.default.find(info["File"]["track"], {
+				_type: mediaType
+			});
+			media = _lodash2.default.merge({}, mediainfoDefaults, media);
+
+			var width = parseInt(media["Width"].replace(" ", "").match(/[0-9 ]+/));
+			var height = parseInt(media["Height"].replace(" ", "").match(/[0-9 ]+/));
+			tags.Resolution = width && height ? width + "x" + height : "";
+
+			tags.Standard = media["Standard"] ? media["Standard"].toLowerCase() : "";
+
+			var scan = /Progressive/.test(media["Scan_type"]) ? "p" : "i";
+			var dimension = /3D/.test(name) ? "3D" : "2D";
+
+			var framerate = media["Frame_rate"].split(" ");
+			if (framerate.length) {
+				var f = framerate[0];
+				if (f == "23.976") {
+					f = "23.98";
+				}
+				f = parseFloat(f).toString();
+				tags.Framerate = f != "NaN" ? f : "";
+			}
+
+			if (!tags.Standard) {
+				switch (tags.Framerate) {
+					case "24":
+					case "23.98":
+					case "29.97":
+					case "59.94":
+						tags.Standard = "ntsc";
+						break;
+					case "25":
+					case "50":
+						tags.Standard = "pal";
+						break;
+				}
+			}
+
+			tags.Codec = function (codec) {
+				switch (codec) {
+					case "AVC":
+						return "h264";
+					case "ProRes":
+						return "prores";
+					default:
+						return "";
+				}
+			}(media["Format"]);
+
+			if (tags.Codec == "h264") {
+				tags.Usage = "online";
+			}
+
+			if (tags.Codec == "prores") {
+				tags.Usage = "broadcast";
+			}
+
+			tags.Aspect = media["Display_aspect_ratio"] || "";
+			tags["Frame Mode"] = media["Scan_type"].toLowerCase();
+
+			return tags;
+		}
+	}, {
+		key: "mapFromKnownData",
+		value: function mapFromKnownData(context, order, tags) {
+			var watermarks = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
+
+
+			if (order.asset) {
+				context = {
+					asset: order.asset._id,
+					project: order.project._id,
+					assetType: order.assetType,
+					purpose: "download"
+				};
+			}
+
+			var previewType = function () {
+				if (order.isSub() && order.isDub()) return "both";
+				if (order.isDub()) return "dub";
+				if (order.isSub()) return "sub";
+			}();
+
+			var isPreviewEnabled = tags.Codec == "prores" && tags.Resolution.split("x")[1] == "1080" && (tags.Framerate == "23.98" || tags.Framerate == "25") && watermarks.length;
+
+			var watermark = watermarks[0] ? watermarks[0]._id : "";
+
+			return {
+				workRequest: order._id,
+				selected: {
+					download: {
+						enabled: true,
+						country: order.country,
+						language: order.language,
+						tags: tags,
+						embargo: {
+							enabled: false
+						}
+					},
+					preview: {
+						enabled: isPreviewEnabled,
+						language: order.language,
+						revision: "Final",
+						type: previewType,
+						watermark: watermark,
+						embargo: {
+							enabled: false
+						}
+					},
+					thumbnail: {
+						enabled: false
+					}
+				},
+				context: context
+			};
+		}
+	}]);
+
+	return Ingest;
+}();
+
+exports.default = Ingest;