capacitor-video-transcoder 0.0.0-stage → 0.0.1

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const VideoTranscoder = registerPlugin('VideoTranscoder', {
+    web: () => import('./web').then((m) => new m.VideoTranscoderWeb()),
+});
+export * from './definitions';
+export { VideoTranscoder };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,eAAe,GAAG,cAAc,CAAwB,iBAAiB,EAAE;IAC/E,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;CACnE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { VideoTranscoderPlugin } from './definitions';\n\nconst VideoTranscoder = registerPlugin<VideoTranscoderPlugin>('VideoTranscoder', {\n  web: () => import('./web').then((m) => new m.VideoTranscoderWeb()),\n});\n\nexport * from './definitions';\nexport { VideoTranscoder };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,6 @@
+import { WebPlugin } from '@capacitor/core';
+import type { TranscodeOptions, TranscodeResult, VideoTranscoderPlugin } from './definitions';
+export declare class VideoTranscoderWeb extends WebPlugin implements VideoTranscoderPlugin {
+    transcode(options: TranscodeOptions): Promise<TranscodeResult>;
+    cancel(): Promise<void>;
+}

package/dist/esm/web.js

@@ -0,0 +1,10 @@
+import { WebPlugin } from '@capacitor/core';
+export class VideoTranscoderWeb extends WebPlugin {
+    async transcode(options) {
+        throw this.unimplemented(`Cannot transcode ${options.source} on the web: it needs the platform's video encoder.`);
+    }
+    async cancel() {
+        throw this.unimplemented('cancel is not available on the web.');
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C,KAAK,CAAC,SAAS,CAAC,OAAyB;QACvC,MAAM,IAAI,CAAC,aAAa,CAAC,oBAAoB,OAAO,CAAC,MAAM,qDAAqD,CAAC,CAAC;IACpH,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,aAAa,CAAC,qCAAqC,CAAC,CAAC;IAClE,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { TranscodeOptions, TranscodeResult, VideoTranscoderPlugin } from './definitions';\n\nexport class VideoTranscoderWeb extends WebPlugin implements VideoTranscoderPlugin {\n  async transcode(options: TranscodeOptions): Promise<TranscodeResult> {\n    throw this.unimplemented(`Cannot transcode ${options.source} on the web: it needs the platform's video encoder.`);\n  }\n\n  async cancel(): Promise<void> {\n    throw this.unimplemented('cancel is not available on the web.');\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const VideoTranscoder = core.registerPlugin('VideoTranscoder', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.VideoTranscoderWeb()),
+});
+
+class VideoTranscoderWeb extends core.WebPlugin {
+    async transcode(options) {
+        throw this.unimplemented(`Cannot transcode ${options.source} on the web: it needs the platform's video encoder.`);
+    }
+    async cancel() {
+        throw this.unimplemented('cancel is not available on the web.');
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    VideoTranscoderWeb: VideoTranscoderWeb
+});
+
+exports.VideoTranscoder = VideoTranscoder;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst VideoTranscoder = registerPlugin('VideoTranscoder', {\n    web: () => import('./web').then((m) => new m.VideoTranscoderWeb()),\n});\nexport * from './definitions';\nexport { VideoTranscoder };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class VideoTranscoderWeb extends WebPlugin {\n    async transcode(options) {\n        throw this.unimplemented(`Cannot transcode ${options.source} on the web: it needs the platform's video encoder.`);\n    }\n    async cancel() {\n        throw this.unimplemented('cancel is not available on the web.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,eAAe,GAAGA,mBAAc,CAAC,iBAAiB,EAAE;AAC1D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;AACtE,CAAC;;ACFM,MAAM,kBAAkB,SAASC,cAAS,CAAC;AAClD,IAAI,MAAM,SAAS,CAAC,OAAO,EAAE;AAC7B,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,iBAAiB,EAAE,OAAO,CAAC,MAAM,CAAC,mDAAmD,CAAC,CAAC;AACzH,IAAI;AACJ,IAAI,MAAM,MAAM,GAAG;AACnB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,qCAAqC,CAAC;AACvE,IAAI;AACJ;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,27 @@
+var capacitorVideoTranscoder = (function (exports, core) {
+    'use strict';
+
+    const VideoTranscoder = core.registerPlugin('VideoTranscoder', {
+        web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.VideoTranscoderWeb()),
+    });
+
+    class VideoTranscoderWeb extends core.WebPlugin {
+        async transcode(options) {
+            throw this.unimplemented(`Cannot transcode ${options.source} on the web: it needs the platform's video encoder.`);
+        }
+        async cancel() {
+            throw this.unimplemented('cancel is not available on the web.');
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        VideoTranscoderWeb: VideoTranscoderWeb
+    });
+
+    exports.VideoTranscoder = VideoTranscoder;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst VideoTranscoder = registerPlugin('VideoTranscoder', {\n    web: () => import('./web').then((m) => new m.VideoTranscoderWeb()),\n});\nexport * from './definitions';\nexport { VideoTranscoder };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class VideoTranscoderWeb extends WebPlugin {\n    async transcode(options) {\n        throw this.unimplemented(`Cannot transcode ${options.source} on the web: it needs the platform's video encoder.`);\n    }\n    async cancel() {\n        throw this.unimplemented('cancel is not available on the web.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,eAAe,GAAGA,mBAAc,CAAC,iBAAiB,EAAE;IAC1D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACtE,CAAC;;ICFM,MAAM,kBAAkB,SAASC,cAAS,CAAC;IAClD,IAAI,MAAM,SAAS,CAAC,OAAO,EAAE;IAC7B,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,iBAAiB,EAAE,OAAO,CAAC,MAAM,CAAC,mDAAmD,CAAC,CAAC;IACzH,IAAI;IACJ,IAAI,MAAM,MAAM,GAAG;IACnB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,qCAAqC,CAAC;IACvE,IAAI;IACJ;;;;;;;;;;;"}

package/ios/Package.swift

@@ -0,0 +1,22 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+// The transcoder without the Capacitor bridge, so that `swift test --package-path ios` runs its tests on a Mac: no simulator, no
+// phone. AVAssetReader and AVAssetWriter are the same on macOS, so the end-to-end tests transcode real files here. The plugin
+// itself is the package at the root of the repository, which builds these same sources.
+let package = Package(
+    name: "VideoTranscoderCore",
+    platforms: [.iOS(.v15), .macOS(.v13)],
+    products: [
+        .library(name: "VideoTranscoderCore", targets: ["VideoTranscoderCore"])
+    ],
+    targets: [
+        .target(
+            name: "VideoTranscoderCore",
+            path: "Sources/VideoTranscoderCore"),
+        .testTarget(
+            name: "VideoTranscoderCoreTests",
+            dependencies: ["VideoTranscoderCore"],
+            path: "Tests/VideoTranscoderCoreTests")
+    ]
+)

package/ios/Sources/VideoTranscoderCore/Geometry.swift

@@ -0,0 +1,61 @@
+import CoreGraphics
+import Foundation
+
+public struct VideoSize: Equatable {
+    public let width: Int
+    public let height: Int
+
+    public init(width: Int, height: Int) {
+        self.width = width
+        self.height = height
+    }
+}
+
+/// The arithmetic of the output: its size, its rotation, its audio format. Pure, so it is tested without a video.
+public enum Geometry {
+    /// The size that fits a video into `maxSize` on its longer side, keeping the aspect ratio and never scaling up. Both sides are
+    /// rounded down to an even number (H.264 4:2:0 halves them for the chroma planes), and are at least 2. Integer arithmetic, so
+    /// 1920x1080 into 1280 is exactly 1280x720 and not 1280x718 from a 719.999 rounded down.
+    public static func outputSize(width: Int, height: Int, maxSize: Int) -> VideoSize {
+        let w = Int64(max(abs(width), 1))
+        let h = Int64(max(abs(height), 1))
+        let longer = max(w, h)
+        let limit = Int64(max(maxSize, 2))
+        func fit(_ side: Int64) -> Int {
+            let scaled = longer > limit ? side * limit / longer : side
+            return Int(max(2, scaled / 2 * 2))
+        }
+        return VideoSize(width: fit(w), height: fit(h))
+    }
+
+    /// The clockwise rotation a track transform applies, in degrees: 0, 90, 180 or 270.
+    public static func rotationDegrees(of transform: CGAffineTransform) -> Int {
+        let degrees = Int((atan2(Double(transform.b), Double(transform.a)) * 180 / .pi).rounded())
+        return ((degrees % 360) + 360) % 360 / 90 * 90
+    }
+
+    /// A stored size as a player shows it, with the track's rotation applied.
+    public static func displayedSize(_ size: VideoSize, rotationDegrees: Int) -> VideoSize {
+        rotationDegrees % 180 == 0 ? size : VideoSize(width: size.height, height: size.width)
+    }
+
+    /// The sample rates the AAC encoder takes.
+    static let aacSampleRates: [Double] = [8_000, 11_025, 12_000, 16_000, 22_050, 24_000, 32_000, 44_100, 48_000]
+
+    /// The AAC format an audio track that is not AAC is encoded to: mono stays mono, stereo stays stereo, more channels are mixed
+    /// down to stereo; the sample rate is the source's when AAC has it, else the next one up, at most 48 kHz. The bitrate is left
+    /// to the encoder, which picks one that suits the sample rate: a fixed 128 kbit/s is refused at 16 kHz ("Cannot Encode Media").
+    public static func aacFormat(sourceChannels: Int, sourceSampleRate: Double) -> (channels: Int, sampleRate: Double) {
+        let channels = sourceChannels <= 1 ? 1 : 2
+        let sampleRate = aacSampleRates.first { $0 >= sourceSampleRate.rounded() } ?? 48_000
+        return (channels, sampleRate)
+    }
+
+    /// Progress from 0 to 1 for a position in a clip, held below 1 until the file is finished.
+    public static func progress(seconds: Double, of duration: Double) -> Double {
+        guard duration > 0, seconds.isFinite else {
+            return 0
+        }
+        return min(max(seconds / duration, 0), 0.99)
+    }
+}

package/ios/Sources/VideoTranscoderCore/TranscodeOptions.swift

@@ -0,0 +1,107 @@
+import CoreFoundation
+import Foundation
+
+/// The `code` a call is rejected with. The raw values are the ones `src/definitions.ts` documents.
+public enum TranscodeErrorCode: String {
+    case invalidArgument = "INVALID_ARGUMENT"
+    case notFound = "NOT_FOUND"
+    case noVideo = "NO_VIDEO"
+    case busy = "BUSY"
+    case cancelled = "CANCELLED"
+    case failed = "FAILED"
+}
+
+public struct TranscodeError: Error, Equatable, CustomStringConvertible {
+    public let code: TranscodeErrorCode
+    public let message: String
+
+    public init(_ code: TranscodeErrorCode, _ message: String) {
+        self.code = code
+        self.message = message
+    }
+
+    public var description: String { "\(code.rawValue): \(message)" }
+}
+
+/// What a `transcode` call asked for, checked and with the defaults filled in.
+public struct TranscodeOptions: Equatable {
+    public static let defaultMaxSize = 1280
+    public static let defaultMaxDurationMs = 30_000
+    public static let defaultVideoBitrate = 1_800_000
+    public static let minimumMaxSize = 16
+
+    public let source: URL
+    /// `nil` when the call named none: a new file in the temporary directory is used.
+    public let destination: URL?
+    public let maxSize: Int
+    public let maxDurationMs: Int
+    public let videoBitrate: Int
+
+    public init(
+        source: URL,
+        destination: URL? = nil,
+        maxSize: Int = TranscodeOptions.defaultMaxSize,
+        maxDurationMs: Int = TranscodeOptions.defaultMaxDurationMs,
+        videoBitrate: Int = TranscodeOptions.defaultVideoBitrate
+    ) {
+        self.source = source
+        self.destination = destination
+        self.maxSize = maxSize
+        self.maxDurationMs = maxDurationMs
+        self.videoBitrate = videoBitrate
+    }
+
+    /// The options of a call as the bridge hands them over. Anything wrong is an `INVALID_ARGUMENT` that says what.
+    public static func parse(_ raw: [String: Any]) throws -> TranscodeOptions {
+        guard let source = raw["source"] as? String, !source.isEmpty else {
+            throw TranscodeError(.invalidArgument, "source is required: an absolute path or a file:// URL")
+        }
+        var destination: URL?
+        if let value = raw["destination"], !(value is NSNull) {
+            guard let text = value as? String else {
+                throw TranscodeError(.invalidArgument, "destination must be a string")
+            }
+            destination = try fileURL(text, name: "destination")
+        }
+        return TranscodeOptions(
+            source: try fileURL(source, name: "source"),
+            destination: destination,
+            maxSize: try wholeNumber(raw["maxSize"], name: "maxSize", minimum: minimumMaxSize, fallback: defaultMaxSize),
+            maxDurationMs: try wholeNumber(raw["maxDurationMs"], name: "maxDurationMs", minimum: 1, fallback: defaultMaxDurationMs),
+            videoBitrate: try wholeNumber(raw["videoBitrate"], name: "videoBitrate", minimum: 1, fallback: defaultVideoBitrate)
+        )
+    }
+
+    /// An absolute path or a `file://` URL as a file URL. Anything else (a relative path, `content://`, `http://`) is refused.
+    public static func fileURL(_ value: String, name: String) throws -> URL {
+        var path = value
+        if value.hasPrefix("file://") {
+            path = String(value.dropFirst("file://".count))
+            if path.hasPrefix("localhost/") {
+                path = String(path.dropFirst("localhost".count))
+            }
+            path = path.removingPercentEncoding ?? path
+        }
+        guard path.hasPrefix("/"), path.count > 1 else {
+            throw TranscodeError(.invalidArgument, "\(name) must be an absolute path or a file:// URL, not \(value)")
+        }
+        return URL(fileURLWithPath: path).standardizedFileURL
+    }
+
+    static func wholeNumber(_ value: Any?, name: String, minimum: Int, fallback: Int) throws -> Int {
+        guard let value, !(value is NSNull) else {
+            return fallback
+        }
+        guard let number = value as? NSNumber, CFGetTypeID(number) != CFBooleanGetTypeID() else {
+            throw TranscodeError(.invalidArgument, "\(name) must be a number")
+        }
+        let double = number.doubleValue
+        guard double.isFinite, double.rounded() == double, double <= Double(Int32.max) else {
+            throw TranscodeError(.invalidArgument, "\(name) must be a whole number, not \(number)")
+        }
+        guard Int(double) >= minimum else {
+            throw TranscodeError(.invalidArgument, "\(name) must be at least \(minimum), not \(number)")
+        }
+        return Int(double)
+    }
+}