Skip to content

cssnr/hls-video-downloader

Repository files navigation

Chrome Web Store Users Mozilla Add-on Users Chrome Web Store Version Mozilla Add-on Version GitHub Release Version Build Test Quality Gate Status GitHub Last Commit GitHub Top Language GitHub Org Stars Discord

HLS Video Downloader

Modern Chrome Web Extension and Firefox Browser Addon to Download HLS Videos using Native FFmpeg.

This Web Extension is a Work in Progress, may contain bugs or not work as expected.

Install

Chrome Firefox Edge Chromium Brave Vivaldi Opera

All Chromium Based Browsers can install the extension from the Chrome Web Store.

Warning

This web extension requires a client app to use native FFmpeg.
Source: https://github.com/cssnr/hls-downloader-client

Features

  • Download *.m3u8 videos using a native ffmpeg application.
  • Shows the total number of streams found on the toolbar icon.
  • Sends a notification when complete you can click on to open the download folder.

Upcoming Features

  • Playlist parsing to display correct qualities and combine audio/video.

Tip

Don't see your feature here? Request one on the Feature Request Discussion.

Known Issues

  • Streams with separate video and audio will show up as 2 downloads.
  • Stream quality display is not yet accurate.
  • Error handling and messages needs improving.

Tip

Don't see your issue here? Open one on the Issues.

Configuration

You can pin the Addon by clicking the Puzzle Piece, find the Web Extension icon, then;
Chrome, click the Pin icon.
Firefox, click the Settings Wheel and Pin to Toolbar.

To open the options, click on the icon (from above) then click Open Options.

Support

For help using the web extension, utilize any these resources:

If you are experiencing an issue/bug or getting unexpected results, use:

Logs can be found inspecting the page (Ctrl+Shift+I), clicking on the Console, and; Firefox: toggling Debug logs, Chrome: toggling Verbose from levels dropdown.

To support this project, see the Contributing section at the bottom.

Development

Quick Start

First, clone (or download) this repository and change into the directory.

Second, install the dependencies:

npm install

Finally, to run Chrome or Firefox with web-ext, run one of the following:

npm run chrome
npm run firefox

Additionally, to Load Unpacked/Temporary Add-on make a manifest.json and run from the src folder, run one of the following:

npm run manifest:chrome
npm run manifest:firefox

Chrome: https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked
Firefox: https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/

For more information on web-ext, read this documentation.
To pass additional arguments to an npm run command, use --.
Example: npm run chrome -- --chromium-binary=...

Building

Install the requirements and copy libraries into the src/dist directory by running npm install. See gulpfile.js for more information on postinstall.

npm install

To create a .zip archive of the src directory for the desired browser run one of the following:

npm run build
npm run build:chrome
npm run build:firefox

For more information on building, see the scripts section in the package.json file.

Chrome Setup

  1. Build or Download a Release.
  2. Unzip the archive, place the folder where it must remain and note its location for later.
  3. Open Chrome, click the 3 dots in the top right, click Extensions, click Manage Extensions.
  4. In the top right, click Developer Mode then on the top left click Load unpacked.
  5. Navigate to the folder you extracted in step #3 then click Select Folder.

Firefox Setup

  1. Build or Download a Release.
  2. Unzip the archive, place the folder where it must remain and note its location for later.
  3. Go to about:debugging#/runtime/this-firefox and click Load Temporary Add-on...
  4. Navigate to the folder you extracted earlier, select manifest.json then click Select File.
  5. Optional: Open about:config search for extensions.webextensions.keepStorageOnUninstall and set to true.

If you need to test a restart, you must pack the addon. This only works in ESR, Development, or Nightly. You may also use an Unbranded Build: https://wiki.mozilla.org/Add-ons/Extension_Signing#Unbranded_Builds

  1. Run npm run build:firefox then use web-ext-artifacts/{name}-firefox-{version}.zip.
  2. Open about:config search for xpinstall.signatures.required and set to false.
  3. Open about:addons and drag the zip file to the page or choose Install from File from the Settings wheel.

Contributing

Currently, the best way to contribute to this project is to give a 5-star rating on Google or Mozilla and to star this project on GitHub.

Other Web Extensions I have created and published:

For a full list of current projects visit: https://cssnr.github.io/