rill-node 0.0.0-stage → 2026.11.15

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+rill
+Copyright 2026 rill contributors
+
+This product includes software developed by third parties, as noted in the
+relevant source files and repository history.
+
+The optional rill-media helper links against FFmpeg (LGPL-2.1-or-later).
+Distributions of that helper must include FFmpeg's license notices and
+comply with its relinking requirements.

package/README.md

@@ -1,3 +1,65 @@
-# Temporary Holding Version
+# rill-node
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Node.js bindings for [Rill](https://github.com/SimaoMoreira5228/rill), a media extractor and downloader.
+
+The package contains a small Node-API addon. It calls the same `librill` library as the Crystal CLI and the other bindings.
+
+## Install
+
+Node 18 or newer is required. Released tarballs contain prebuilt native directories, so installation does not need Crystal. If the matching platform directory is missing, the install script builds `librill` from the bundled Crystal source:
+
+```sh
+npm install rill-node
+```
+
+If you have a compatible build already, point the install at it:
+
+```sh
+RILL_LIB_DIR=/path/to/rill/build npm install rill-node
+# or
+RILL_LIBRARY=/path/to/librill.so npm install rill-node
+```
+
+Building from source needs Crystal 1.22 or newer. On a machine without Crystal, set `RILL_LIB_DIR` or `RILL_LIBRARY`.
+
+Released tarballs contain `native/<platform>/` directories with the addon, `librill`, and a statically linked `rill-media` helper. `index.js` loads the matching directory and points `RILL_MEDIA_HELPER` at the helper, so separate video and audio streams can be merged without a system FFmpeg.
+
+## Extract
+
+```js
+const rill = require("rill-node");
+
+rill.init(4);
+
+const json = rill.extractJsonSync("https://example.com/clip.mp4");
+console.log(JSON.parse(json));
+
+const asyncJson = await rill.extractJson("https://example.com/clip.mp4");
+
+rill.shutdown();
+```
+
+## Download
+
+```js
+const { Download, DownloadState } = require("rill-node");
+
+const download = new Download("https://example.com/clip.mp4", "clip.mp4", '{"overwrite":true}');
+const progress = await download.wait();
+
+if (progress.state !== DownloadState.Completed) {
+  console.error(download.error());
+}
+
+download.close();
+```
+
+`close()` is idempotent. `waitSync()` uses `Atomics.wait` and is available when a blocking loop is acceptable.
+
+## Errors
+
+Extraction rejects with an `Error` carrying a `code` property such as `unsupported_url` or `media_unavailable`.
+
+## License
+
+Apache-2.0. See the repository [LICENSE](https://github.com/SimaoMoreira5228/rill/blob/main/LICENSE).

package/binding.gyp

@@ -0,0 +1,31 @@
+{
+  "targets": [
+    {
+      "target_name": "rill_node",
+      "sources": ["src/addon.c"],
+      "include_dirs": ["native-src/include", "../../include"],
+      "library_dirs": ["<!@(node scripts/libdir.js)"],
+      "libraries": ["<!@(node scripts/lib.js)"],
+      "conditions": [
+        [
+          "OS=='linux'",
+          {
+            "ldflags": [
+              "-Wl,-rpath,'$$ORIGIN'",
+              "-Wl,-rpath,<!(node scripts/libdir.js)"
+            ]
+          }
+        ],
+        [
+          "OS=='mac'",
+          {
+            "ldflags": [
+              "-Wl,-rpath,@loader_path",
+              "-Wl,-rpath,<!(node scripts/libdir.js)"
+            ]
+          }
+        ]
+      ]
+    }
+  ]
+}

package/index.d.ts

@@ -0,0 +1,45 @@
+export declare function abiVersion(): number;
+
+export declare function init(workers?: number): void;
+
+export declare function shutdown(): void;
+
+export declare function extractJsonSync(url: string, options?: string): string;
+
+export declare function extractJson(url: string, options?: string): Promise<string>;
+
+export declare enum DownloadState {
+  Queued = 0,
+  Running = 1,
+  Completed = 2,
+  Failed = 3,
+  Cancelled = 4,
+}
+
+export interface DownloadProgress {
+  state: DownloadState;
+  downloaded: number;
+  total: number;
+}
+
+export interface RillError extends Error {
+  code?: string;
+}
+
+export declare class Download {
+  constructor(url: string, output: string, options?: string);
+
+  poll(): DownloadProgress;
+
+  cancel(): void;
+
+  error(): string;
+
+  errorCode(): string;
+
+  close(): void;
+
+  wait(intervalMs?: number): Promise<DownloadProgress>;
+
+  waitSync(intervalMs?: number): DownloadProgress;
+}

package/index.js

@@ -0,0 +1,112 @@
+"use strict";
+
+const fs = require("node:fs");
+const path = require("node:path");
+const { helperName, nativeDir } = require("./scripts/platform.js");
+
+const platformDirectory = nativeDir(__dirname);
+const helperCandidates = [
+  path.join(platformDirectory, helperName()),
+  path.join(__dirname, "native", helperName()),
+  path.join(__dirname, "..", "..", "build", helperName()),
+  path.join(process.cwd(), "build", helperName()),
+];
+const mediaHelper = helperCandidates.find((candidate) => fs.existsSync(candidate));
+
+if (mediaHelper && !process.env.RILL_MEDIA_HELPER) {
+  process.env.RILL_MEDIA_HELPER = mediaHelper;
+}
+
+const prebuiltAddon = path.join(platformDirectory, "rill_node.node");
+const addon = require(
+  fs.existsSync(prebuiltAddon) ? prebuiltAddon : "./build/Release/rill_node.node",
+);
+
+const DownloadState = Object.freeze({
+  Queued: 0,
+  Running: 1,
+  Completed: 2,
+  Failed: 3,
+  Cancelled: 4,
+});
+
+class Download {
+  constructor(url, output, options = undefined) {
+    this.handle = addon.downloadStart(url, output, options);
+  }
+
+  poll() {
+    this.ensureOpen();
+    return addon.downloadPoll(this.handle);
+  }
+
+  cancel() {
+    this.ensureOpen();
+    addon.downloadCancel(this.handle);
+  }
+
+  error() {
+    this.ensureOpen();
+    return addon.downloadError(this.handle);
+  }
+
+  errorCode() {
+    this.ensureOpen();
+    return addon.downloadErrorCode(this.handle);
+  }
+
+  close() {
+    if (this.handle) {
+      addon.downloadClose(this.handle);
+      this.handle = null;
+    }
+  }
+
+  ensureOpen() {
+    if (!this.handle) {
+      throw new Error("download is closed");
+    }
+  }
+
+  async wait(intervalMs = 50) {
+    while (true) {
+      const progress = this.poll();
+      if (
+        progress.state === DownloadState.Completed ||
+        progress.state === DownloadState.Failed ||
+        progress.state === DownloadState.Cancelled
+      ) {
+        return progress;
+      }
+
+      await new Promise((resolve) => setTimeout(resolve, intervalMs));
+    }
+  }
+
+  waitSync(intervalMs = 50) {
+    const sleeper = new Int32Array(new SharedArrayBuffer(4));
+
+    while (true) {
+      const progress = this.poll();
+      if (
+        progress.state === DownloadState.Completed ||
+        progress.state === DownloadState.Failed ||
+        progress.state === DownloadState.Cancelled
+      ) {
+        return progress;
+      }
+
+      Atomics.wait(sleeper, 0, 0, intervalMs);
+    }
+  }
+}
+
+module.exports = {
+  abiVersion: addon.abiVersion,
+  init: addon.init,
+  shutdown: addon.shutdown,
+  extractJsonSync: addon.extractJsonSync,
+  extractJson: addon.extractJson,
+  Download,
+  DownloadState,
+};

package/native-src/include/rill.h

@@ -0,0 +1,90 @@
+#ifndef RILL_H
+#define RILL_H
+
+#include <stddef.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define RILL_ABI_VERSION 2
+
+typedef enum rill_status {
+  RILL_OK = 0,
+  RILL_ERROR_EXTRACTION = 1,
+  RILL_ERROR_INTERNAL = 2,
+  RILL_ERROR_INVALID_ARGUMENT = 3,
+  RILL_ERROR_SHUTDOWN = 4,
+  RILL_ERROR_CANCELLED = 5
+} rill_status;
+
+typedef enum rill_download_state {
+  RILL_DOWNLOAD_QUEUED = 0,
+  RILL_DOWNLOAD_RUNNING = 1,
+  RILL_DOWNLOAD_COMPLETED = 2,
+  RILL_DOWNLOAD_FAILED = 3,
+  RILL_DOWNLOAD_CANCELLED = 4
+} rill_download_state;
+
+// Opaque asynchronous extraction request.
+typedef struct rill_job rill_job;
+
+// Opaque asynchronous download request.
+typedef struct rill_job rill_download;
+
+// Returned strings are owned by the caller and must be released with
+// rill_free_string. A job transfers its result strings to rill_job_wait;
+// rill_job_free releases anything that was not transferred.
+//
+// Extraction options_json accepts a JSON object with these optional keys:
+//   user_agent, headers (object of string or string array), cookies (object),
+//   connect_timeout_seconds, read_timeout_seconds, retry_delay_seconds,
+//   max_redirects, retries, max_response_bytes.
+//
+// Download options_json accepts these optional keys:
+//   request (an extraction options object), format_id, audio_only,
+//   video_only, overwrite, resume, media_backend (auto, helper, system, off).
+
+int rill_abi_version(void);
+
+// Starts the worker pool. Call once before any other function. worker_count 0
+// selects one worker. Returns RILL_OK when the pool is ready or already running.
+int rill_init(size_t worker_count);
+
+// Stops the worker pool. Queued jobs fail with RILL_ERROR_SHUTDOWN, active
+// downloads are cancelled, and in-flight extraction calls finish normally.
+// Terminal: later calls to rill_init fail. Safe to call more than once.
+int rill_shutdown(void);
+
+// Enqueues an extraction. Returns NULL only when the job cannot be allocated.
+rill_job *rill_job_new(const char *url, const char *options_json);
+int rill_job_wait(rill_job *job, char **json_out, char **error_out,
+                  char **error_code_out);
+void rill_job_free(rill_job *job);
+
+// Blocking convenience wrapper around rill_job_new, rill_job_wait, and
+// rill_job_free.
+int rill_extract_json(const char *url, const char *options_json,
+                      char **json_out, char **error_out,
+                      char **error_code_out);
+
+// Starts an asynchronous download. Returns NULL only when the job cannot be
+// allocated. Poll it with short, non-blocking calls; never block a runtime's
+// event loop on this API.
+rill_download *rill_download_start(const char *url, const char *output_path,
+                                   const char *options_json, char **error_out);
+int rill_download_poll(rill_download *download, int *state, int64_t *downloaded,
+                       int64_t *total);
+char *rill_download_error(rill_download *download);
+char *rill_download_error_code(rill_download *download);
+int rill_download_cancel(rill_download *download);
+void rill_download_free(rill_download *download);
+
+void rill_free_string(char *value);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

package/native-src/include/rill_media.h

@@ -0,0 +1,22 @@
+#ifndef RILL_MEDIA_H
+#define RILL_MEDIA_H
+
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Remuxes one video-only input and one audio-only input into a single file.
+// Streams are copied; no decoding or encoding happens. Returns 0 on success.
+int rill_media_merge(const char *video_path, const char *audio_path,
+                     const char *output_path, int overwrite, char *error,
+                     size_t error_size);
+
+const char *rill_media_version(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

package/native-src/shard.yml

@@ -0,0 +1,9 @@
+name: rill
+version: 2026.11.15
+crystal: ">= 1.22.0"
+license: Apache-2.0
+description: Media extractor and downloader
+
+targets:
+  rill:
+    main: src/cli.cr