Merge pull request #123 from hadronepoch/shalmor-patch-1

aminyazdanpanah · web-flow · commit f31f038f50fe · 2023-08-13T16:33:26.000-04:00
Update README.md
diff --git a/README.md b/README.md
@@ -1,14 +1,11 @@
 # 📼 Python FFmpeg Video Streaming
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/aminyazdanpanah/python-ffmpeg-video-streaming/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/aminyazdanpanah/python-ffmpeg-video-streaming/?branch=master)
 [![Downloads](https://pepy.tech/badge/python-ffmpeg-video-streaming)](https://pepy.tech/project/python-ffmpeg-video-streaming)
-[![PyPI version](https://badge.fury.io/py/python-ffmpeg-video-streaming.svg)](https://badge.fury.io/py/python-ffmpeg-video-streaming)
-[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/blob/master/LICENSE)
 
 ## Overview
 This package uses the **[FFmpeg](https://ffmpeg.org)** to package media content for online streaming such as DASH and HLS. You can also use **[DRM](https://en.wikipedia.org/wiki/Digital_rights_management)** for HLS packaging. There are several options to open a file from a cloud and save files to clouds as well.
-- **[Full Documentation](https://video.aminyazdanpanah.com/python/)** is available describing all features and components.
-- In this version(>=v0.1.0) all codes are rewritten from scratch. If you find any bugs in the library, please **[file an issue](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/issues)**. **[Pull requests](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/pulls)** are also welcome.
- 
+- **[Full Documentation](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/)** is available describing all features and components.
+- **Your support is crucial to our ongoing work on open-source projects**. We kindly request that you consider exploring the **[available options](#support-us)** to assist us in this endeavor. Your encouragement and assistance will help us continue to deliver high-quality results in this important area. Thank you for your consideration and support.
+
 **Contents**
 - [Requirements](#requirements)
 - [Installation](#installation)
@@ -23,6 +20,7 @@ This package uses the **[FFmpeg](https://ffmpeg.org)** to package media content
   - [Conversion](#conversion)
 - [Several Open Source Players](#several-open-source-players)
 - [FAQs](#faqs)
+- [Support Us](#support-us)
 - [Contributing and Reporting Bugs](#contributing-and-reporting-bugs)
 - [Credits](#credits)
 - [License](#license)
@@ -61,7 +59,7 @@ See **[FFmpeg Protocols Documentation](https://ffmpeg.org/ffmpeg-protocols.html)
 
 **For example:** 
 ```python
-video = ffmpeg_streaming.input('https://www.aminyazdanpanah.com/?"PATH TO A VIDEO FILE" or "PATH TO A LIVE HTTP STREAM"')
+video = ffmpeg_streaming.input('https://www.hadronepoch.org/?"PATH TO A VIDEO FILE" or "PATH TO A LIVE HTTP STREAM"')
 ```
 
 #### 2. From Clouds
@@ -73,7 +71,7 @@ s3 = S3(aws_access_key_id='YOUR_KEY_ID', aws_secret_access_key='YOUR_KEY_SECRET'
 
 video = ffmpeg_streaming.input(s3, bucket_name="bucket-name", key="video.mp4")
 ```
-Visit **[this page](https://video.aminyazdanpanah.com/python/start/clouds?r=open)** to see some examples of opening a file from **[Amazon S3](https://aws.amazon.com/s3)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud.
+Visit **[this page](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/start/clouds?r=open)** to see some examples of opening a file from **[Amazon S3](https://aws.amazon.com/s3)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud.
 
 #### 3. Capture Webcam or Screen (Live Streaming)
 You can pass the name of a supported, connected capture device(i.e. the name of a webcam, camera, screen and etc) to the `input` method to stream a live media over the network from your connected device. 
@@ -112,7 +110,7 @@ dash = video.dash(Formats.h264())
 dash.representations(_144p, _240p, _360p, _480p, _720p, _1080p, _2k, _4k)
 dash.output('/var/media/dash.mpd')
 ```
-See **[DASH section](https://video.aminyazdanpanah.com/python/start?r=dash#dash)** in the documentation, for more examples.
+See **[DASH section](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/start?r=dash#dash)** in the documentation, for more examples.
 ### HLS
 **[HTTP Live Streaming (also known as HLS)](https://developer.apple.com/streaming/)** is an HTTP-based adaptive bitrate streaming communications protocol implemented by Apple Inc. as part of its QuickTime, Safari, OS X, and iOS software. Client implementations are also available in Microsoft Edge, Firefox, and some versions of Google Chrome. Support is widespread in streaming media servers. [Learn more](https://en.wikipedia.org/wiki/HTTP_Live_Streaming)
  
@@ -136,7 +134,7 @@ hls = video.hls(Formats.h264())
 hls.representations(_360p, _480p, _720p)
 hls.output('/var/media/hls.m3u8')
 ```
-See **[HLS section](https://video.aminyazdanpanah.com/python/start?r=hls#hls)** in the documentation, for more examples such as Fragmented MP4, live from camera/screen and so on.
+See **[HLS section](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/start?r=hls#hls)** in the documentation, for more examples such as Fragmented MP4, live from camera/screen and so on.
 
 #### Encryption(DRM)
 The encryption process requires some kind of secret (key) together with an encryption algorithm. HLS uses AES in cipher block chaining (CBC) mode. This means each block is encrypted using the ciphertext of the preceding block. [Learn more](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation)
@@ -153,7 +151,7 @@ from ffmpeg_streaming import Formats
 save_to = '/home/public_html/"PATH TO THE KEY DIRECTORY"/key'
 
 #A URL (or a path) to access the key on your website
-url = 'https://www.aminyazdanpanah.com/?"PATH TO THE KEY DIRECTORY"/key'
+url = 'https://www.hadronepoch.org/?"PATH TO THE KEY DIRECTORY"/key'
 # or url = '/"PATH TO THE KEY DIRECTORY"/key';
 
 hls = video.hls(Formats.h264())
@@ -165,7 +163,7 @@ hls.output('/var/media/hls.m3u8')
 ##### Key Rotation
 An integer as a "key rotation period" can also be passed to the `encryption` method (i.e. `encryption(save_to, url, 10)`) to use a different key for each set of segments, rotating to a new key after this many segments. For example, if 10 segment files have been generated then it will generate a new key. If you set this value to **`1`**, each segment file will be encrypted with a new encryption key. This can improve security and allows for more flexibility. 
 
-See **[the example](https://video.aminyazdanpanah.com/python/start?r=enc-hls#hls-encryption)** for more information.
+See **[the example](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/start?r=enc-hls#hls-encryption)** for more information.
 
 **IMPORTANT:** It is very important to protect your key(s) on your website. For example, you can use a token(using a Get/Post HTTP method or add a token to authorization header) to check if the user is eligible to access the key or not. You can also use a session(or cookie) on your website to restrict access to the key(s)(**It is highly recommended**).    
 
@@ -275,7 +273,7 @@ A path can also be passed to save a copy of files to your local machine.
 hls.output('/var/media/hls.m3u8', clouds=save_to_s3)
 ```
 
-Visit **[this page](https://video.aminyazdanpanah.com/python/start/clouds?r=save)** to see some examples of saving files to **[Amazon S3](https://aws.amazon.com/s3)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud. 
+Visit **[this page](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/start/clouds?r=save)** to see some examples of saving files to **[Amazon S3](https://aws.amazon.com/s3)**, **[Google Cloud Storage](https://console.cloud.google.com/storage)**, **[Microsoft Azure Storage](https://azure.microsoft.com/en-us/features/storage-explorer/)**, and a custom cloud. 
 
 **NOTE:** This option is only valid for **[VOD](https://en.wikipedia.org/wiki/Video_on_demand)** (it does not support live streaming).
 
@@ -305,7 +303,7 @@ from ffmpeg_streaming import FFProbe
 ffprobe = FFProbe('/var/media/video.mp4')
 ```
 
-See **[the example](https://video.aminyazdanpanah.com/python/start?r=metadata#metadata)** for more information.
+See **[the example](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/start?r=metadata#metadata)** for more information.
 
 ### Conversion
 You can convert your stream to a file or to another stream protocol. You should pass a manifest of the stream to the `input` method:
@@ -314,7 +312,7 @@ You can convert your stream to a file or to another stream protocol. You should
 ```python
 from ffmpeg_streaming import Formats, Bitrate, Representation, Size
 
-video = ffmpeg_streaming.input('https://www.aminyazdanpanah.com/?PATH/TO/HLS-MANIFEST.M3U8')
+video = ffmpeg_streaming.input('https://www.hadronepoch.org/?PATH/TO/HLS-MANIFEST.M3U8')
 
 _480p  = Representation(Size(854, 480), Bitrate(750 * 1024, 192 * 1024))
 
@@ -325,7 +323,7 @@ dash.output('/var/media/dash.mpd')
 
 #### 2. DASH To HLS
 ```python
-video = ffmpeg_streaming.input('https://www.aminyazdanpanah.com/?PATH/TO/DASH-MANIFEST.MPD')
+video = ffmpeg_streaming.input('https://www.hadronepoch.org/?PATH/TO/DASH-MANIFEST.MPD')
 
 hls = video.hls(Formats.h264())
 hls.auto_generate_representations()
@@ -334,7 +332,7 @@ hls.output('/var/media/hls.m3u8')
 
 #### 3. Stream(DASH or HLS) To File
 ```python
-video = ffmpeg_streaming.input('https://www.aminyazdanpanah.com/?PATH/TO/MANIFEST.MPD or M3U8')
+video = ffmpeg_streaming.input('https://www.hadronepoch.org/?PATH/TO/MANIFEST.MPD or M3U8')
 
 stream = video.stream2file(Formats.h264())
 stream.output('/var/media/new-video.mp4')
@@ -374,7 +372,7 @@ You can use these libraries to play your streams.
 
 ## FAQs
 **I created stream files and now what should I pass to a player?**
-You must pass a **master playlist(manifest) URL**(e.x. `https://www.aminyazdanpanah.com/?"PATH TO STREAM DIRECTORY"/dash-stream.mpd` or `/PATH_TO_STREAM_DIRECTORY/hls-stream.m3u8` ) to a player. 
+You must pass a **master playlist(manifest) URL**(e.x. `https://www.hadronepoch.org/?"PATH TO STREAM DIRECTORY"/dash-stream.mpd` or `/PATH_TO_STREAM_DIRECTORY/hls-stream.m3u8` ) to a player. 
 See the demo page of these players for more information(**[hls.js Demo](https://hls-js.netlify.app/demo/)**, **[dash.js Demo](https://reference.dashif.org/dash.js/v3.1.2/samples/dash-if-reference-player/index.html)**, **[videojs Demo](https://videojs.com/advanced?video=elephantsdream)** and etc).  
 
 **My player does not show the quality selector button to change the video quality?**
@@ -386,16 +384,28 @@ If you save your stream content to a cloud(i.e. **[Amazon S3](https://aws.amazon
 **Does [IOS](https://www.apple.com/ios) support the DASH stream?**
 No, IOS does not have native support for DASH. Although there are some libraries such as **[Viblast](https://github.com/Viblast/ios-player-sdk)** and **[MPEGDASH-iOS-Player](https://github.com/MPEGDASHPlayer/MPEGDASH-iOS-Player)** to support this technique, I have never tested them. So maybe some of them will not work properly.
 
-See [this page](https://video.aminyazdanpanah.com/python/start?r=faq#faq) for more FAQs.
+See [this page](https://https://www.hadronepoch.org/op/python/ffmpeg-streaming/start?r=faq#faq) for more FAQs.
+
+## Support Us
+We greatly appreciate your support in our efforts to contribute to open-source projects. If you're able to, we kindly ask that you take a moment to check out the available options for assisting us. Your help would enable us to maintain our commitment to producing exceptional results. Thank you for your support.
+
+### 1. purchasing a service or product
+Our company offers a range of products and services, including video streaming, video-on-demand, video conferencing, and an HR assistance application. If you wish to purchase any of these offerings, kindly direct your inquiries to our email address at **contact@hadronepoch.org**. We will be updating **[our website](https://www.hadronepoch.org)** with further details in the near future.
+
+### 2. sponsoring the project or org 
+Thank you for considering the option of sponsoring our organization. Your generous donations will greatly assist us in our efforts to enhance and expand our existing libraries, as well as build new ones. There are several options available for sponsorship, including clicking on the **[provided link](https://github.com/sponsors/hadronepoch)** or utilizing alternative methods such as **[crypto](https://hadronepoch.org/support)**, **[Patreon](https://patreon.com/HadronEpoch)**, **[Open Collective](https://opencollective.com/hadronepoch)**, and **[ko-fi](https://ko-fi.com/hadronepoch)**. Your support is greatly appreciated and will help us to continue our mission of providing valuable resources to the community.
 
+### 3. Star and Share
+If you find this project to be of value, kindly consider **[starring it](stargazers)** and **sharing it** with those in your network who may benefit from this type of software. Your support would be greatly appreciated and would help to increase visibility and accessibility of this project. 
 
+Thank you for your consideration. 
 ## Contributing and Reporting Bugs
 I'd love your help in improving, correcting, adding to the specification. Please **[file an issue](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/issues)** or **[submit a pull request](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/pulls)**.
 - See **[Contributing File](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/blob/master/CONTRIBUTING.md)** for more information.
 - If you discover a security vulnerability within this package, please see **[SECURITY File](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/blob/master/SECURITY.md)** for more information.
 
 ## Credits
-- **[Amin Yazdanpanah](https://www.aminyazdanpanah.com/?u=github.com/aminyazdanpanah/python-ffmpeg-video-streaming)**
+- **[Amin Yazdanpanah](https://www.hadronepoch.org/?u=github.com/aminyazdanpanah/python-ffmpeg-video-streaming)**
 - **[All Contributors](https://github.com/aminyazdanpanah/python-ffmpeg-video-streaming/graphs/contributors)**
 
 ## License
