Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transcode server for remote #611

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions node/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@

// =================================================================================================

// transcode

const ffmpegPath = require('@ffmpeg-installer/ffmpeg').path.replace('app.asar', 'app.asar.unpacked');
const spawn = require('child_process').spawn;
const onFinished = require('on-finished');

// ---

export function setUpIpcForServer(ipc) {

ipc.on('latest-gallery-view', (event, data): void => {
Expand Down Expand Up @@ -94,6 +102,38 @@
// res.end();
// });


app.get('/video', (req, res) => {
const seekTime = req.query.seek || 0;
const file = req.query.file || '';
// see https://trac.ffmpeg.org/wiki/Encode/H.264#a2.Chooseapreset for more options
const ffmpeg = spawn(ffmpegPath, [
'-ss', seekTime,
'-i', file,
'-f', 'mp4',
'-crf', '17',
'-preset', 'ultrafast',
'-movflags', 'frag_keyframe+empty_moov+faststart',
'-frag_duration', '15',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can probably remove this - I think it might have a sensible default anyway. We can change it later.

The idea with fragmenting, is that you can seek and stream much easier, without having to download the entire mp4 file before playback can begin. Each fragment contains metadata about the video, rather than all the metadata being store at the end of the file!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can look into finding the best options, but if the code works as is, may as well use that for now!

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Cal for looking at this again. I've paused this feature for a while because I had at least two days of trying hard with no success: getting the video to play in Chrome ✅ no problem 👌 but getting Safari on iOS (on my phone) to play anything was a no-go 😓 which is the sole purpose of this feature.

I'll come back to this with renewed energy once I move in to the new house (these few months have been busy).

😅 also I've been working on an image-centric analogous-to-VHA app this past month -- I want to finish it first before returning to this headache :trollface:

'pipe:1'
]);
res.writeHead(200, {
'Content-Type': 'video/mp4'
});
ffmpeg.stdout.pipe(res);
// error logging
ffmpeg.stderr.setEncoding('utf8');
ffmpeg.stderr.on('data', (data) => {
console.log(data);
});
onFinished(res, () => {
console.log('about to kill!');
ffmpeg.kill();
});
});
Comment on lines +106 to +133

Check failure

Code scanning / CodeQL

Missing rate limiting High

This route handler performs
a system command
, but is not rate-limited.

Copilot Autofix AI 4 months ago

To fix the problem, we will introduce rate limiting to the Express application using the express-rate-limit package. This will limit the number of requests to the /video endpoint, preventing abuse and potential DoS attacks.

  1. Install the express-rate-limit package.
  2. Import the express-rate-limit package in the node/server.ts file.
  3. Set up a rate limiter with appropriate configuration (e.g., maximum of 100 requests per 15 minutes).
  4. Apply the rate limiter to the /video endpoint.
Suggested changeset 2
node/server.ts

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/node/server.ts b/node/server.ts
--- a/node/server.ts
+++ b/node/server.ts
@@ -5,2 +5,3 @@
 const express = require('express');
+const rateLimit = require('express-rate-limit');
 // const bodyParser = require('body-parser'); ----------------------------- disabled
@@ -89,2 +90,7 @@
 
+  const videoLimiter = rateLimit({
+    windowMs: 15 * 60 * 1000, // 15 minutes
+    max: 100 // limit each IP to 100 requests per windowMs
+  });
+
   // app.use(bodyParser.json()); // to handle JSON POST requests ------ disabled
@@ -105,3 +111,3 @@
 
-  app.get('/video', (req, res) => {
+  app.get('/video', videoLimiter, (req, res) => {
     const seekTime = req.query.seek || 0;
EOF
@@ -5,2 +5,3 @@
const express = require('express');
const rateLimit = require('express-rate-limit');
// const bodyParser = require('body-parser'); ----------------------------- disabled
@@ -89,2 +90,7 @@

const videoLimiter = rateLimit({
windowMs: 15 * 60 * 1000, // 15 minutes
max: 100 // limit each IP to 100 requests per windowMs
});

// app.use(bodyParser.json()); // to handle JSON POST requests ------ disabled
@@ -105,3 +111,3 @@

app.get('/video', (req, res) => {
app.get('/video', videoLimiter, (req, res) => {
const seekTime = req.query.seek || 0;
package.json
Outside changed files

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/package.json b/package.json
--- a/package.json
+++ b/package.json
@@ -63,3 +63,4 @@
     "tslib": "2.8.0",
-    "ws": "8.18.0"
+    "ws": "8.18.0",
+    "express-rate-limit": "^7.4.1"
   },
EOF
@@ -63,3 +63,4 @@
"tslib": "2.8.0",
"ws": "8.18.0"
"ws": "8.18.0",
"express-rate-limit": "^7.4.1"
},
This fix introduces these dependencies
Package Version Security advisories
express-rate-limit (npm) 7.4.1 None
Copilot is powered by AI and may make mistakes. Always verify output.
Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options



// Serve the Angular VHA remote control app
app.use(express.static(remoteAppPath));

Expand Down
33 changes: 33 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading