Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dotnettools/sharpgrabber

Download from YouTube, Vimeo, HLS (M3U8 files) and more with .NET and JavaScript - Library and desktop app for downloading high quality media
https://github.com/dotnettools/sharpgrabber

blackwidow cross-platform ecmascript ffmpeg high-quality hls instagram javascript m3u8 media-converter net-core net-standard pornhub video vimeo xnxx xvideos youtube youtube-dl

Last synced: 3 days ago
JSON representation

Download from YouTube, Vimeo, HLS (M3U8 files) and more with .NET and JavaScript - Library and desktop app for downloading high quality media

Awesome Lists containing this project

README

        

SharpGrabber

# SharpGrabber

[![GitHub](https://img.shields.io/github/license/dotnettools/SharpGrabber)](https://github.com/dotnettools/SharpGrabber/blob/master/LICENSE)
[![NuGet download count](https://img.shields.io/nuget/dt/SharpGrabber)](https://www.nuget.org/packages/SharpGrabber)
[![Build](https://github.com/dotnettools/SharpGrabber/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/dotnettools/SharpGrabber/actions/workflows/build.yml)

This repository contains multiple related projects:
- `SharpGrabber` is a *.NET Standard* library for scraping top media providers and grabbing high quality video, audio and information.
- `SharpGrabber.Converter` is a *.NET Standard* library based on `ffmpeg` shared libraries to join audio and video streams. This is particularly useful when grabbing high quality *YouTube* media that might be separated into audio and video files. It is also used for merging HLS stream segments.
- `SharpGrabber.BlackWidow` is a *.NET Standard* library for grabbing with JavaScript, which has many advantages over using scattered NuGet packages.
- `SharpGrabber.Desktop` A cross-platform desktop application which utilizes all three libraries mentioned above to expose their functionality to desktop end-users.

# How to Use
[Go to Documentation](https://github.com/dotnettools/SharpGrabber/wiki)


Quick Start


## Package Installation
The `SharpGrabber` package defines abstractions only. The actual grabbers have their own packages and should be installed separately.

### SharpGrabber - Core Package
Install-Package SharpGrabber -Version 2.1.1

### SharpGrabber.Converter
It's an optional package to work with media files. Using this package, you can easily concatenate video segments, or mux audio and video channels.
It uses `ffmpeg` shared libraries underneath.

Install-Package SharpGrabber.Converter -Version 1.1

### HLS - M3U8 playlists
This package adds the capability to parse M3U8 playlist files - including master playlists - and download video segments.
With the help of the `SharpGrabber.Converter` package, segments may be joined together.
This package also supports `AES-128` decryption.

Install-Package SharpGrabber.Hls -Version 1.3

### YouTube
Adds support to download high-quality videos from YouTube, even if they are served as separate video and audio files only.
The high-quality output is possible thanks to the `SharpGrabber.Converter` library.

Install-Package SharpGrabber.YouTube -Version 1.5

### Vimeo
Install-Package SharpGrabber.Vimeo -Version 1.0

### Odysee
Install-Package SharpGrabber.Odysee -Version 1.0.1

### Instagram
Warning: This grabber is not guaranteed to work. It works only for clients that Instagram allows anonymous access to public content.

Install-Package SharpGrabber.Instagram -Version 0.1

### Adult - `PornHub`, `xnxx`, and `xvideos`

Install-Package SharpGrabber.Adult -Version 1.0.2

## Quick Start
### 1. Start with building a Grabber

```csharp
var grabber = GrabberBuilder.New()
.UseDefaultServices()
.AddYouTube()
.AddVimeo()
.Build();
```

This will result in the creation of a "multi-grabber".

What grabbers you can "add" depends on what packages you've installed. In this example, we have installed YouTube and Vimeo packages.

### 2. Grab from a URI

```csharp
var result = await grabber.GrabAsync(new Uri("https://www.youtube.com/watch?v=LTseTg48568"));
```

No matter what website the URI refers to, the multi-grabber will detect the provider and put the right grabber to use.

### 3. Process the Result

```csharp
var info = result.Resource();
Console.WriteLine("Time Length: {0}", info.Length);
var images = result.Resources();
var videos = result.Resources();
```

## Upgrade From 1.x to 2.x
ATTENTION! Beware of the breaking changes since v2.0 that requires you to update your code.
The good news is no functionality has been removed, so with a minor refactoring, you should be good to go!
I strongly recommend that you upgrade, v2 has a much cleaner structure and code.


## SharpGrabber.Desktop
### Version 4.8
- Grabs from every source supported by the official grabbers i.e. grabbers implemented in this Git repository.
- Displays information and downloads videos, audios, images etc.
- Merges YouTube separated audio and video streams into complete media files; as well as joining HLS segments!
- BlackWidow integrated

Requirements of the cross-platform desktop application to run and operate correctly:
- .NET Core 3.1
- **Shared libraries** of *ffmpeg* copied into the `ffmpeg` directory alongside the application executable files for media manipulation support.
- On Windows, you may download the latest BtbN ffmpeg build.
- On any OS check out the official website.

Download the latest binaries from the releases page.

SharpGrabber.Desktop Application

# Introducing BlackWidow
SharpGrabber

BlackWidow executes scripts written specifically for grabbing, rather than relying on .NET assemblies.
- **Always Up-to-date:** The scripts are always kept up-to-date at runtime; so the functionality of the host application won't break as the sources change - at least not for long!
- **ECMAScript Support:** Supports JavaScript/ECMAScript out of the box.
- **Easy Maintenance:** *JavaScript* is quick to code and welcomes many developers. This helps contributors to quickly write new grabbers or fix the existing ones.
- **Secure**: The scripts are executed in a sandbox environment, and they only have access to what the BlackWidow API exposes to them.
- **Highly Customizable:** Almost everything is open for extension or replacement. Make new script interpreters, custom grabber repositories, or roll out your own interpreter APIs

Read more + Documentation

## Contribution
You are most welcome to contribute!
- Authentication mechanisms for grabbers e.g. Instagram Login
- Support for more media providers such as *DailyMotion*, *Facebook*, *Twitch* etc.
- Accelerate downloads in the desktop app (like a download manager)

## Disclaimer
SharpGrabber library, BlackWidow and other projects and libraries provided in this repository are developed for educational purposes.
Since it's illegal to extract copyrighted data, you should make sure your usage of the tools provided here complies with copyright laws.
Contributors to these tools are not responsible for any copyright infringement that may occur per usage.

## License
Copyright © 2023 SharpGrabber contributors

This project is licensed under the GNU Lesser General Public License (LGPL) version 3.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.