├── err.out ├── src ├── constants │ ├── index.ts │ └── surah.ts ├── structures │ ├── index.ts │ ├── api │ │ ├── verses │ │ │ ├── index.ts │ │ │ ├── GET.ts │ │ │ └── interfaces.ts │ │ ├── options │ │ │ ├── index.ts │ │ │ ├── GET.ts │ │ │ └── interfaces.ts │ │ └── index.ts │ ├── ClientManager.ts │ └── Client.ts ├── utils │ ├── logger.ts │ ├── index.ts │ ├── convert_woff2-tff.ts │ ├── download_font.ts │ ├── get_font.ts │ ├── download_stream.ts │ └── install_font.ts └── index.ts ├── .prettierrc.json ├── .gitignore ├── assets ├── Open-Koran-Book.png ├── Quran-on-a-Stand.png ├── An-Open-Islam-Book.png ├── Close-up-of-a-Quran.png ├── Stained-Book-Page.png ├── A-Woman-Reading-a-Quran.png ├── Close-Up-of-a-Holy-Quran.png ├── Koran-on-White-Surface.png ├── Quran-on-Wooden-Surface.png ├── White-and-Red-Book-Page.png ├── A-Person-Reading-the-Quran.png ├── Grayscale-Photo-of-a-Quran.png ├── Quran-Lying-on-Small-Table.png ├── Quran-on-Wooden-Top-Board.png ├── A-Person-Holding-a-Koran-Book.png ├── Father-and-Son-Reading-a-Book.png ├── Holy-Quran-on-Brown-Surface.png ├── Holy-Quran-on-White-Surface.png ├── Opened-Book-on-Plastic-Chair.png ├── An-Open-Quran-on-Brown-Surface.png ├── Open-Book-on-Black-Wooden-Table.png ├── Brown-Wooden-Bench-on-White-Floor.png ├── Gift-Boxes-And-Holy-Book-On-Table.png ├── Photo-Of-Quran-Beside-Lighted-Candle.png ├── Unrecognizable-Man-Reading-the-Quran.png ├── A-Child-Hugging-Green-and-Yellow-Book.png ├── A-Man-in-Gray-Suit-Reading-a-Koran-Book.png ├── Back-View-Shot-of-a-Man-Reading-a-Koran.png ├── Crop-person-holding-opened-Koran-book.png ├── Man-in-Black-Suit-Jacket-Reading-a-Book.png ├── Man-in-White-Dress-Shirt-Reading-Book.png ├── Person-in-Beige-Clothing-reading-Koran.png ├── Photo-Of-Person-Holding-Religous-Book.png ├── Woman-in-Black-Jacket-Raising-Her-Hands.png ├── A-Koran-on-Wooden-Stand-Inside-the-Mosque.png ├── Close-up-Photo-of-Man-in-Traditional-Wear.png ├── Man-in-White-Thobe-Sitting-on-the-Ground.png ├── Man-in-Black-Suit-Jacket-Holding-Blue-Book.png ├── Black-Tablet-and-Prayer-Beads-on-a-Prayer-Rug.png ├── Man-in-Gray-Suit-Standing-while-Reading-a-Book.png ├── A-Man-in-Gray-Suit-Standing-Near-the-Koran-Stand.png ├── Islam-scripture-in-Arabic-language-in-person-hand.png ├── Man-in-Gray-Long-Sleeve-Shirt-Holding-Blue-Book.png ├── Photo-Of-An-Open-Book-Beside-Red-Lighted-Candle.png ├── Girl-in-White-Hijab-and-Black-Long-Sleeves-Praying.png ├── Muslim-Boy-Studying-Quran-Next-to-Tray-of-Cupcakes.png ├── African-man-in-religious-with-Quran-in-Muslim-mosque.png ├── Black-and-Gold-Book-on-White-and-Brown-Floral-Textile.png ├── Girl-in-White-Hijab-and-Blue-and-White-Long-Sleeve-Shirt.png ├── A-Man-in-White-Thobe-Holding-a-Koran-with-His-Eyes-Closed.png ├── A-Man-in-White-Thobe-Sitting-on-the-Floor-while-Reading-a-Koran.png ├── High-angle-of-opened-Koran-book-placed-on-stone-stand-in-yard-of-ancient-mosque.png ├── From-above-of-crop-person-reading-Koran-with-colorful-red-pages-and-Arabic-script.png ├── Girl-in-White-Hijab-and-Blue-Long-Sleeve-Shirt-Sitting-on-Floor-in-Front-of-a-Book.png └── Concentrated-African-male-in-Islamic-prayer-cap-and-robe-reading-Koran-sitting-on-floor-against-door.png ├── config.json ├── .github └── dependabot.yml ├── README.md ├── tsconfig.json ├── package.json ├── fonts.ps1 └── LICENSE /err.out: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/constants/index.ts: -------------------------------------------------------------------------------- 1 | export * from "./surah"; 2 | -------------------------------------------------------------------------------- /.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "tabWidth": 4, 3 | "useTabs": true 4 | } 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | pnpm-lock.yaml 2 | node_modules 3 | tmp 4 | editly-* 5 | .env 6 | yt-auth 7 | dist 8 | output.mp4 -------------------------------------------------------------------------------- /assets/Open-Koran-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Open-Koran-Book.png -------------------------------------------------------------------------------- /assets/Quran-on-a-Stand.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Quran-on-a-Stand.png -------------------------------------------------------------------------------- /assets/An-Open-Islam-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/An-Open-Islam-Book.png -------------------------------------------------------------------------------- /assets/Close-up-of-a-Quran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Close-up-of-a-Quran.png -------------------------------------------------------------------------------- /assets/Stained-Book-Page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Stained-Book-Page.png -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "debug": true, 3 | "create": 1, 4 | "surah": 1, 5 | "verse": 1, 6 | "recitation": 3 7 | } 8 | -------------------------------------------------------------------------------- /src/structures/index.ts: -------------------------------------------------------------------------------- 1 | export * from "./api"; 2 | export * from "./ClientManager"; 3 | export * from "./Client"; 4 | -------------------------------------------------------------------------------- /assets/A-Woman-Reading-a-Quran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Woman-Reading-a-Quran.png -------------------------------------------------------------------------------- /assets/Close-Up-of-a-Holy-Quran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Close-Up-of-a-Holy-Quran.png -------------------------------------------------------------------------------- /assets/Koran-on-White-Surface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Koran-on-White-Surface.png -------------------------------------------------------------------------------- /assets/Quran-on-Wooden-Surface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Quran-on-Wooden-Surface.png -------------------------------------------------------------------------------- /assets/White-and-Red-Book-Page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/White-and-Red-Book-Page.png -------------------------------------------------------------------------------- /assets/A-Person-Reading-the-Quran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Person-Reading-the-Quran.png -------------------------------------------------------------------------------- /assets/Grayscale-Photo-of-a-Quran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Grayscale-Photo-of-a-Quran.png -------------------------------------------------------------------------------- /assets/Quran-Lying-on-Small-Table.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Quran-Lying-on-Small-Table.png -------------------------------------------------------------------------------- /assets/Quran-on-Wooden-Top-Board.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Quran-on-Wooden-Top-Board.png -------------------------------------------------------------------------------- /assets/A-Person-Holding-a-Koran-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Person-Holding-a-Koran-Book.png -------------------------------------------------------------------------------- /assets/Father-and-Son-Reading-a-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Father-and-Son-Reading-a-Book.png -------------------------------------------------------------------------------- /assets/Holy-Quran-on-Brown-Surface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Holy-Quran-on-Brown-Surface.png -------------------------------------------------------------------------------- /assets/Holy-Quran-on-White-Surface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Holy-Quran-on-White-Surface.png -------------------------------------------------------------------------------- /assets/Opened-Book-on-Plastic-Chair.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Opened-Book-on-Plastic-Chair.png -------------------------------------------------------------------------------- /assets/An-Open-Quran-on-Brown-Surface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/An-Open-Quran-on-Brown-Surface.png -------------------------------------------------------------------------------- /assets/Open-Book-on-Black-Wooden-Table.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Open-Book-on-Black-Wooden-Table.png -------------------------------------------------------------------------------- /assets/Brown-Wooden-Bench-on-White-Floor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Brown-Wooden-Bench-on-White-Floor.png -------------------------------------------------------------------------------- /assets/Gift-Boxes-And-Holy-Book-On-Table.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Gift-Boxes-And-Holy-Book-On-Table.png -------------------------------------------------------------------------------- /assets/Photo-Of-Quran-Beside-Lighted-Candle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Photo-Of-Quran-Beside-Lighted-Candle.png -------------------------------------------------------------------------------- /assets/Unrecognizable-Man-Reading-the-Quran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Unrecognizable-Man-Reading-the-Quran.png -------------------------------------------------------------------------------- /assets/A-Child-Hugging-Green-and-Yellow-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Child-Hugging-Green-and-Yellow-Book.png -------------------------------------------------------------------------------- /assets/A-Man-in-Gray-Suit-Reading-a-Koran-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Man-in-Gray-Suit-Reading-a-Koran-Book.png -------------------------------------------------------------------------------- /assets/Back-View-Shot-of-a-Man-Reading-a-Koran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Back-View-Shot-of-a-Man-Reading-a-Koran.png -------------------------------------------------------------------------------- /assets/Crop-person-holding-opened-Koran-book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Crop-person-holding-opened-Koran-book.png -------------------------------------------------------------------------------- /assets/Man-in-Black-Suit-Jacket-Reading-a-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Man-in-Black-Suit-Jacket-Reading-a-Book.png -------------------------------------------------------------------------------- /assets/Man-in-White-Dress-Shirt-Reading-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Man-in-White-Dress-Shirt-Reading-Book.png -------------------------------------------------------------------------------- /assets/Person-in-Beige-Clothing-reading-Koran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Person-in-Beige-Clothing-reading-Koran.png -------------------------------------------------------------------------------- /assets/Photo-Of-Person-Holding-Religous-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Photo-Of-Person-Holding-Religous-Book.png -------------------------------------------------------------------------------- /assets/Woman-in-Black-Jacket-Raising-Her-Hands.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Woman-in-Black-Jacket-Raising-Her-Hands.png -------------------------------------------------------------------------------- /assets/A-Koran-on-Wooden-Stand-Inside-the-Mosque.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Koran-on-Wooden-Stand-Inside-the-Mosque.png -------------------------------------------------------------------------------- /assets/Close-up-Photo-of-Man-in-Traditional-Wear.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Close-up-Photo-of-Man-in-Traditional-Wear.png -------------------------------------------------------------------------------- /assets/Man-in-White-Thobe-Sitting-on-the-Ground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Man-in-White-Thobe-Sitting-on-the-Ground.png -------------------------------------------------------------------------------- /assets/Man-in-Black-Suit-Jacket-Holding-Blue-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Man-in-Black-Suit-Jacket-Holding-Blue-Book.png -------------------------------------------------------------------------------- /assets/Black-Tablet-and-Prayer-Beads-on-a-Prayer-Rug.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Black-Tablet-and-Prayer-Beads-on-a-Prayer-Rug.png -------------------------------------------------------------------------------- /assets/Man-in-Gray-Suit-Standing-while-Reading-a-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Man-in-Gray-Suit-Standing-while-Reading-a-Book.png -------------------------------------------------------------------------------- /assets/A-Man-in-Gray-Suit-Standing-Near-the-Koran-Stand.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Man-in-Gray-Suit-Standing-Near-the-Koran-Stand.png -------------------------------------------------------------------------------- /assets/Islam-scripture-in-Arabic-language-in-person-hand.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Islam-scripture-in-Arabic-language-in-person-hand.png -------------------------------------------------------------------------------- /assets/Man-in-Gray-Long-Sleeve-Shirt-Holding-Blue-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Man-in-Gray-Long-Sleeve-Shirt-Holding-Blue-Book.png -------------------------------------------------------------------------------- /assets/Photo-Of-An-Open-Book-Beside-Red-Lighted-Candle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Photo-Of-An-Open-Book-Beside-Red-Lighted-Candle.png -------------------------------------------------------------------------------- /assets/Girl-in-White-Hijab-and-Black-Long-Sleeves-Praying.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Girl-in-White-Hijab-and-Black-Long-Sleeves-Praying.png -------------------------------------------------------------------------------- /assets/Muslim-Boy-Studying-Quran-Next-to-Tray-of-Cupcakes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Muslim-Boy-Studying-Quran-Next-to-Tray-of-Cupcakes.png -------------------------------------------------------------------------------- /assets/African-man-in-religious-with-Quran-in-Muslim-mosque.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/African-man-in-religious-with-Quran-in-Muslim-mosque.png -------------------------------------------------------------------------------- /assets/Black-and-Gold-Book-on-White-and-Brown-Floral-Textile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Black-and-Gold-Book-on-White-and-Brown-Floral-Textile.png -------------------------------------------------------------------------------- /assets/Girl-in-White-Hijab-and-Blue-and-White-Long-Sleeve-Shirt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Girl-in-White-Hijab-and-Blue-and-White-Long-Sleeve-Shirt.png -------------------------------------------------------------------------------- /assets/A-Man-in-White-Thobe-Holding-a-Koran-with-His-Eyes-Closed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Man-in-White-Thobe-Holding-a-Koran-with-His-Eyes-Closed.png -------------------------------------------------------------------------------- /src/structures/api/verses/index.ts: -------------------------------------------------------------------------------- 1 | import { Api } from ".."; 2 | import { GET } from "./GET"; 3 | 4 | export class Verses { 5 | get = new GET(this); 6 | constructor(public api: Api) {} 7 | } 8 | -------------------------------------------------------------------------------- /assets/A-Man-in-White-Thobe-Sitting-on-the-Floor-while-Reading-a-Koran.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/A-Man-in-White-Thobe-Sitting-on-the-Floor-while-Reading-a-Koran.png -------------------------------------------------------------------------------- /src/structures/api/options/index.ts: -------------------------------------------------------------------------------- 1 | import { Api } from "../../api"; 2 | import { GET } from "./GET"; 3 | 4 | export class Options { 5 | get = new GET(this); 6 | constructor(public api: Api) {} 7 | } 8 | -------------------------------------------------------------------------------- /src/utils/logger.ts: -------------------------------------------------------------------------------- 1 | export class Logger { 2 | constructor(public active: boolean) {} 3 | debug(...messages: any[]) { 4 | if (!this.active) return; 5 | console.log("[DEBUG]: ", ...messages); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /assets/High-angle-of-opened-Koran-book-placed-on-stone-stand-in-yard-of-ancient-mosque.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/High-angle-of-opened-Koran-book-placed-on-stone-stand-in-yard-of-ancient-mosque.png -------------------------------------------------------------------------------- /src/utils/index.ts: -------------------------------------------------------------------------------- 1 | export * from "./convert_woff2-tff"; 2 | export * from "./get_font"; 3 | export * from "./install_font"; 4 | export * from "./download_font"; 5 | export * from "./download_stream"; 6 | export * from "./logger"; 7 | -------------------------------------------------------------------------------- /assets/From-above-of-crop-person-reading-Koran-with-colorful-red-pages-and-Arabic-script.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/From-above-of-crop-person-reading-Koran-with-colorful-red-pages-and-Arabic-script.png -------------------------------------------------------------------------------- /assets/Girl-in-White-Hijab-and-Blue-Long-Sleeve-Shirt-Sitting-on-Floor-in-Front-of-a-Book.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Girl-in-White-Hijab-and-Blue-Long-Sleeve-Shirt-Sitting-on-Floor-in-Front-of-a-Book.png -------------------------------------------------------------------------------- /assets/Concentrated-African-male-in-Islamic-prayer-cap-and-robe-reading-Koran-sitting-on-floor-against-door.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/z7pz/quran-shorts/HEAD/assets/Concentrated-African-male-in-Islamic-prayer-cap-and-robe-reading-Koran-sitting-on-floor-against-door.png -------------------------------------------------------------------------------- /src/structures/api/index.ts: -------------------------------------------------------------------------------- 1 | import axios from "axios"; 2 | import { Options } from "./options"; 3 | import { Verses } from "./verses"; 4 | 5 | export class Api { 6 | axios = axios.create({ 7 | baseURL: "http://api.quran.com/api/v3/", 8 | }); 9 | options = new Options(this); 10 | verses = new Verses(this); 11 | } 12 | -------------------------------------------------------------------------------- /src/utils/convert_woff2-tff.ts: -------------------------------------------------------------------------------- 1 | import wawoff2 from "wawoff2"; 2 | import fs from "fs/promises"; 3 | import { join } from "path"; 4 | 5 | export async function convert_woff2_tff(n: number, fontsDir: string) { 6 | const woff2Buffer = await fs.readFile( 7 | join(fontsDir, `p${n}.woff2`) 8 | ); 9 | const compressed = Uint8Array.from(woff2Buffer); 10 | const decompressed = await wawoff2.decompress(compressed); 11 | await fs.writeFile(join(fontsDir, `p${n}.ttf`), decompressed); 12 | } 13 | -------------------------------------------------------------------------------- /src/utils/download_font.ts: -------------------------------------------------------------------------------- 1 | import { readFile } from "fs/promises"; 2 | import { join } from "path"; 3 | import { downloadFile } from "."; 4 | 5 | export async function download_font(n: number, fontsDir: string) { 6 | const test = await readFile(join(fontsDir, `p${n}.ttf`)).catch( 7 | () => true 8 | ); 9 | if (test !== true) return true; 10 | await downloadFile( 11 | `https://quran.com/fonts/quran/hafs/v1/woff2/p${n}.woff2`, 12 | join(fontsDir, `p${n}.woff2`) 13 | ); 14 | return false; 15 | } 16 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "npm" # See documentation for possible values 9 | directory: "/" # Location of package manifests 10 | schedule: 11 | interval: "daily" 12 | -------------------------------------------------------------------------------- /src/utils/get_font.ts: -------------------------------------------------------------------------------- 1 | import { dirname, join } from "path"; 2 | import { fileURLToPath } from "url"; 3 | import { convert_woff2_tff, download_font, install_font } from "."; 4 | export async function get_font(n: number) { 5 | const __filename = fileURLToPath(import.meta.url); 6 | const __dirname = dirname(__filename); 7 | const fontsDir = join(__dirname, "..", "tmp", "fonts"); 8 | const available = await download_font(n, fontsDir); 9 | if (available) return join(fontsDir, `p${n}.ttf`); 10 | await convert_woff2_tff(n, fontsDir); 11 | await install_font(n); 12 | return join(fontsDir, `p${n}.ttf`); 13 | } 14 | -------------------------------------------------------------------------------- /src/structures/api/options/GET.ts: -------------------------------------------------------------------------------- 1 | import { Options } from "."; 2 | import { IRecitations, ITranslations, ITafsirs } from "./interfaces"; 3 | 4 | export class GET { 5 | constructor(public options: Options) {} 6 | async recitations() { 7 | return ( 8 | await this.options.api.axios.get( 9 | "options/recitations" 10 | ) 11 | ).data; 12 | } 13 | async translations() { 14 | return ( 15 | await this.options.api.axios.get( 16 | "options/translations" 17 | ) 18 | ).data; 19 | } 20 | async tafsirs() { 21 | return (await this.options.api.axios.get("options/tafsirs")) 22 | .data; 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/utils/download_stream.ts: -------------------------------------------------------------------------------- 1 | import axios from "axios"; 2 | import { createWriteStream } from "fs"; 3 | 4 | export async function downloadFile( 5 | fileUrl: string, 6 | outputLocationPath: string 7 | ) { 8 | const writer = createWriteStream(outputLocationPath); 9 | 10 | return axios({ 11 | method: "get", 12 | url: fileUrl, 13 | responseType: "stream", 14 | }).then((response) => { 15 | return new Promise((resolve, reject) => { 16 | response.data.pipe(writer); 17 | let error: Error | null = null; 18 | writer.on("error", (err) => { 19 | error = err; 20 | writer.close(); 21 | reject(err); 22 | }); 23 | writer.on("close", () => { 24 | if (!error) { 25 | resolve(true); 26 | } 27 | }); 28 | }); 29 | }); 30 | } 31 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # quran-shorts 2 | 3 | basically, upload shorts videos of quran into (youtube, instagram, tiktok) 4 | 5 | # Features 6 | 7 | - support youtube 8 | - support (windows) 9 | - still beta 10 | 11 | # TODO 12 | 13 | - [ ] dont download existed files (mp3, fonts) 14 | - [ ] support linux [#1](/../../issues/1) 15 | - [ ] delete tmp files 16 | - [x] fix bugs (end of the surah and ...) 17 | - [ ] add estimated number of videos 18 | - [ ] start from the last upload 19 | - [x] add backgroud as asset 20 | - [ ] generate backgrounds 21 | - [ ] loop over recitations 22 | 23 | # Usage 24 | 25 | create `.env` file 26 | add missing fields 27 | 28 | ``` 29 | email="your email" 30 | password="your password" 31 | recoveryEmail="" # not necessary 32 | ``` 33 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ESNext", 4 | "module": "ESNext", 5 | "moduleResolution": "node", 6 | "allowSyntheticDefaultImports": true, 7 | "importHelpers": true, 8 | "alwaysStrict": true, 9 | "sourceMap": true, 10 | "forceConsistentCasingInFileNames": true, 11 | "noFallthroughCasesInSwitch": true, 12 | "noImplicitReturns": true, 13 | "noImplicitAny": false, 14 | "noImplicitThis": false, 15 | "strictNullChecks": false, 16 | "esModuleInterop": true, 17 | "rootDir": ".", 18 | "baseUrl": "src", 19 | "outDir": "dist", 20 | "removeComments": true, 21 | "skipLibCheck": true, 22 | "declaration": true, 23 | "resolveJsonModule": true, 24 | "declarationDir": "./dist/types" 25 | }, 26 | "ts-node": { 27 | "esm": true 28 | }, 29 | "include": ["src/**/*", "./config.json"], 30 | "exclude": ["node_modules", "*/node_modules/**"] 31 | } 32 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "7snat", 3 | "version": "1.0.0", 4 | "description": "Create & upload shorts videos of quran into (youtube, instagram, tiktok)", 5 | "main": "index.js", 6 | "type": "module", 7 | "scripts": { 8 | "dev": "nodemon --experimental-specifier-resolution=node ./src/index.ts" 9 | }, 10 | "keywords": [], 11 | "author": "z7pz", 12 | "license": "GPL-3.0", 13 | "dependencies": { 14 | "axios": "^1.2.2", 15 | "dotenv": "^16.0.3", 16 | "editly": "^0.14.2", 17 | "fs": "0.0.1-security", 18 | "https": "^1.0.0", 19 | "node-gyp": "^9.3.1", 20 | "p-queue": "^7.3.0", 21 | "puppeteer": "^19.5.2", 22 | "puppeteer-core": "^19.5.2", 23 | "wawoff2": "^2.0.1", 24 | "woff2": "^1.0.0", 25 | "youtube-videos-uploader": "^2.0.8", 26 | "prettier": "2.8.7" 27 | }, 28 | "devDependencies": { 29 | "@types/node": "^18.11.18", 30 | "@types/wawoff2": "^1.0.0" 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/structures/api/options/interfaces.ts: -------------------------------------------------------------------------------- 1 | type TLanguage = "english" | "arabic"; 2 | interface ITranslatedName { 3 | name: string; 4 | language_name: string; // lang 5 | } 6 | interface IRecitation { 7 | id: number; 8 | reciter_name: string; 9 | style: string; 10 | translated_name: ITranslatedName; 11 | } 12 | export interface IRecitations { 13 | recitations: IRecitation[]; 14 | } 15 | 16 | interface ITranslation { 17 | id: number; 18 | name: string; 19 | author_name: string; 20 | slug: string; 21 | language_name: TLanguage; 22 | translated_name: ITranslatedName; 23 | } 24 | 25 | export interface ITranslations { 26 | translations: ITranslation[]; 27 | } 28 | 29 | interface ITafsir { 30 | id: number; 31 | name: string; 32 | author_name: string; 33 | slug: string; 34 | language_name: TLanguage; 35 | translated_name: ITranslatedName; 36 | } 37 | 38 | export interface ITafsirs { 39 | tafsirs: ITafsir[]; 40 | } 41 | -------------------------------------------------------------------------------- /src/structures/api/verses/GET.ts: -------------------------------------------------------------------------------- 1 | import { Verses } from "."; 2 | import { Type, TVerses } from "./interfaces"; 3 | 4 | interface IOptions { 5 | recitation: number; 6 | surah: number; 7 | type: T; 8 | translations: number; 9 | page: number; 10 | limit: number; 11 | offset: number; 12 | } 13 | 14 | export class GET { 15 | private options: IOptions = { 16 | recitation: 1, 17 | surah: 1, 18 | type: "words", 19 | translations: 21, 20 | page: 1, 21 | limit: 10, 22 | offset: 0, 23 | }; 24 | constructor(public verses: Verses) {} 25 | async list(options?: Partial>) { 26 | Object.assign(this.options, options ?? {}); 27 | return ( 28 | await this.verses.api.axios.get>( 29 | `chapters/${this.options.surah}/verses?recitation=${this.options.recitation}&translations=${this.options.translations}&language=en&text_type=${this.options.type}&limit=${this.options.limit}&offset=${this.options.offset}&page=${this.options.page}` 30 | ) 31 | ).data; 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /fonts.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .SYNOPSIS 3 | Installs the provided fonts. 4 | .DESCRIPTION 5 | Installs all the provided fonts by default. The FontName 6 | parameter can be used to pick a subset of fonts to install. 7 | .EXAMPLE 8 | C:\PS> ./install.ps1 9 | Installs all the fonts located in the Git repository. 10 | .EXAMPLE 11 | C:\PS> ./install.ps1 furamono-, hack-* 12 | Installs all the FuraMono and Hack fonts. 13 | .EXAMPLE 14 | C:\PS> ./install.ps1 d* -WhatIf 15 | Shows which fonts would be installed without actually installing the fonts. 16 | Remove the "-WhatIf" to install the fonts. 17 | #> 18 | [CmdletBinding(SupportsShouldProcess)] 19 | param( 20 | # Specifies the font name to install. Default value will install all fonts. 21 | [Parameter(Position=0)] 22 | [string[]] 23 | $FontName = '*' 24 | ) 25 | 26 | $fontFiles = New-Object 'System.Collections.Generic.List[System.IO.FileInfo]' 27 | foreach ($aFontName in $FontName) { 28 | Get-ChildItem $PSScriptRoot -Filter "${aFontName}.ttf" -Recurse | Foreach-Object {$fontFiles.Add($_)} 29 | Get-ChildItem $PSScriptRoot -Filter "${aFontName}.otf" -Recurse | Foreach-Object {$fontFiles.Add($_)} 30 | } 31 | 32 | $fonts = $null 33 | foreach ($fontFile in $fontFiles) { 34 | if ($PSCmdlet.ShouldProcess($fontFile.Name, "Install Font")) { 35 | if (!$fonts) { 36 | $shellApp = New-Object -ComObject shell.application 37 | $fonts = $shellApp.NameSpace(0x14) 38 | } 39 | $fonts.CopyHere($fontFile.FullName) 40 | } 41 | } -------------------------------------------------------------------------------- /src/utils/install_font.ts: -------------------------------------------------------------------------------- 1 | import { execSync } from "child_process"; 2 | import fs, { copyFile, readdir } from "fs/promises"; 3 | import { dirname, join } from "path"; 4 | import { fileURLToPath } from "url"; 5 | 6 | function getUserHome() { 7 | return process.env[process.platform == "win32" ? "USERPROFILE" : "HOME"]; 8 | } 9 | 10 | /** 11 | * install the font into the system 12 | * 13 | * windows supported 14 | * linux supported 15 | */ 16 | 17 | export async function install_font(n: number) { 18 | const __filename = fileURLToPath(import.meta.url); 19 | const __dirname = dirname(__filename); 20 | switch (process.platform) { 21 | case "win32": { 22 | function promiseFromChildProcess(child: any) { 23 | return new Promise(function (resolve, reject) { 24 | child.addListener("error", reject); 25 | child.addListener("exit", resolve); 26 | }); 27 | } 28 | 29 | const files = await fs.readdir( 30 | getUserHome() + "\\AppData\\Local\\Microsoft\\Windows\\Fonts" 31 | ); 32 | 33 | if (files.includes(`p${n}.ttf`)) { 34 | return; 35 | } 36 | 37 | let child = execSync( 38 | `powershell.exe ./fonts.ps1 src\\tmp\\fonts\\p${n} >> err.out` 39 | ); 40 | 41 | const promise = promiseFromChildProcess(child).then( 42 | function (result) { 43 | console.log("promise complete: " + result); 44 | }, 45 | function (err) { 46 | console.log("promise rejected: " + err); 47 | } 48 | ); 49 | 50 | return promise; 51 | } 52 | case "linux": { 53 | // you dont need to install it on linux.... bruh 54 | return; 55 | } 56 | default: { 57 | throw Error("Your OS is not supported. " + process.platform); 58 | } 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /src/structures/api/verses/interfaces.ts: -------------------------------------------------------------------------------- 1 | type TLanguage = "english" | "arabic"; 2 | type TAuthors = ""; // TODO 3 | type TVerseKey = `${number}:${number}`; 4 | export type Type = "words" | "image"; 5 | export type TVerses = T extends "words" 6 | ? IListWord 7 | : IListImage; 8 | export interface IWord { 9 | id: number; 10 | position: number; 11 | text_indopak: string; 12 | verse_key: TVerseKey; 13 | line_number: number; 14 | page_number: number; 15 | code: string; // "ﭑ" 16 | class_name: string; // "p1" 17 | text_madani: string; 18 | char_type: string; // word // type 19 | transliteration: { 20 | text: string; 21 | language_name: TLanguage; 22 | }; 23 | translation: { 24 | language_name: TLanguage; 25 | text: string; 26 | }; 27 | audio: { 28 | url: string | null; // "wbw/001_001_001.mp3", null cuz of the number of Aea 29 | }; 30 | } 31 | export interface IVerseWord { 32 | id: number; 33 | verse_number: number; 34 | chapter_id: number; 35 | verse_key: TVerseKey; 36 | text_indopak: string; 37 | juz_number: number; 38 | hizb_number: number; 39 | rub_el_hizb_number: number; 40 | sajdah_number: null | number; 41 | page_number: number; 42 | sajdah: null | number; 43 | text_madani: string; 44 | words: IWord[]; 45 | } 46 | 47 | interface Image { 48 | url: string; 49 | width: number; 50 | } 51 | 52 | export interface IVerseImage { 53 | id: number; 54 | verse_number: number; 55 | chapter_id: number; 56 | verse_key: TVerseKey; 57 | text_indopak: string; 58 | juz_number: number; 59 | hizb_number: number; 60 | rub_el_hizb_number: number; 61 | sajdah_number: null | number; 62 | page_number: number; 63 | sajdah: null | number; 64 | text_madani: string; 65 | image: Image; 66 | audio: { 67 | url: string | null; // "wbw/001_001_001.mp3", null cuz of the number of Aea 68 | duration: number | null; 69 | segments: [[number, number, number, number]]; // [[number, number, number, number]] 70 | }; 71 | } 72 | 73 | interface IPagination { 74 | current_page: number; 75 | next_page: null | number; 76 | prev_page: null | number; 77 | total_pages: number; 78 | total_count: number; 79 | } 80 | export interface IListWord { 81 | verses: IVerseWord[]; 82 | pagination: IPagination; 83 | } 84 | export interface IListImage { 85 | verses: IVerseImage[]; 86 | pagination: IPagination; 87 | } 88 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { config as env } from "dotenv"; 2 | import { Client } from "../src/structures/Client"; 3 | import config from "../config.json" assert { type: "json" }; 4 | import axios from "axios"; 5 | env(); 6 | 7 | const client = new Client({ 8 | debug: config.debug, 9 | }); 10 | (async () => { 11 | // configurations 12 | let surah = config.surah; 13 | let offset = config.verse - 1; 14 | let create = config.create; 15 | 16 | // remove console functions from global obj, and copy them into a new obj 17 | let _console = {} as Console; 18 | if (!client.logger.active) { 19 | Object.entries(console).forEach(([key, value]) => { 20 | _console[key] = value; 21 | console[key] = () => {}; 22 | }); 23 | // we need this for Error throwing 24 | console.error = _console.error; 25 | } else { 26 | // expecting this to be empty obj 27 | _console = console; 28 | } 29 | 30 | 31 | // get all recitations 32 | const { data: res } = await axios.get<{ 33 | recitations: { 34 | id: number; 35 | reciter_name: string; // english 36 | style?: "string"; 37 | translated_name: { 38 | name: string; // arabic 39 | language_name: "arabic" | "english"; 40 | }; 41 | }[]; 42 | }>("http://api.quran.com/api/v3/options/recitations?language=ar"); 43 | 44 | // user can pass either name of the recitation or the id of him 45 | // NOTE: name both work for (ar, en) 46 | let recitation = config.recitation as string | number; 47 | 48 | // check user input if it's a number 49 | function isNum(r: unknown): r is number { 50 | return !isNaN(Number(r)); 51 | } 52 | // check user input if it's a string 53 | function isStr(r: unknown): r is string { 54 | return typeof r == "string"; 55 | } 56 | // try to find the recitation 57 | const rec = res.recitations.find( 58 | (data) => 59 | (isNum(recitation) && data.id == recitation) || 60 | (isStr(recitation) && data.reciter_name == recitation) || 61 | (isStr(recitation) && data.translated_name.name == recitation) 62 | ); 63 | 64 | if (!rec) { 65 | throw Error("Recitation not found!!"); 66 | } 67 | 68 | let i = 0; 69 | while (create > i) { 70 | const video = await client.build(offset, surah, i, rec.id); 71 | if (!client.logger.active) await client.upload(video); 72 | surah = video.surah; 73 | offset = video.offset; 74 | i++; 75 | } 76 | console.log("All done!"); 77 | })(); 78 | -------------------------------------------------------------------------------- /src/structures/ClientManager.ts: -------------------------------------------------------------------------------- 1 | import { dirname, join } from "path"; 2 | import { fileURLToPath } from "url"; 3 | import { downloadFile, Logger } from "../utils"; 4 | import { Api } from "./api"; 5 | import { IListImage } from "./api/verses/interfaces"; 6 | import PQueue from "p-queue"; 7 | 8 | interface IPaths { 9 | i: number; 10 | name: string; 11 | duration: number; 12 | font: number; 13 | words: { 14 | i: number; 15 | text: string; 16 | code: string; 17 | p: string; 18 | }[]; 19 | } 20 | 21 | export class ClientManager { 22 | api = new Api(); 23 | constructor( 24 | public page: number, 25 | public current: number, 26 | public verses: IListImage["verses"], 27 | public surah: number, 28 | public offset: number, 29 | public logger: Logger 30 | ) {} 31 | getAudio() { 32 | return this.verses.map((verse) => [ 33 | verse.audio.url, 34 | verse.audio.duration, 35 | ]); 36 | } 37 | /** 38 | * get verses (words type) because it has Qurani words with the end of the verse 39 | */ 40 | async getVerses() { 41 | const words = this.verses.map((_verse, i) => { 42 | return async () => { 43 | this.logger.debug("getting verses words of verse " + i); 44 | return await this.api.verses.get.list({ 45 | offset: this.offset, 46 | limit: this.page, 47 | surah: this.surah, 48 | type: "words", 49 | }); 50 | }; 51 | }); 52 | this.logger.debug(`getting words of ${this.verses.length} verse.`); 53 | const res = await new PQueue().addAll(words); 54 | return res; 55 | } 56 | /** 57 | * get the words and get important things from it 58 | */ 59 | async getWords() { 60 | let verses = await this.getVerses(); 61 | const words = verses[0].verses.map((verse) => { 62 | return { 63 | id: verse.id, 64 | words: verse.words.map((word, i) => { 65 | return { 66 | i, 67 | text: word.text_indopak, 68 | code: word.code, 69 | p: word.class_name, 70 | }; 71 | }), 72 | }; 73 | }); 74 | return words; 75 | } 76 | /** 77 | * download audio files (mp3) 78 | */ 79 | async download() { 80 | const __filename = fileURLToPath(import.meta.url); 81 | const __dirname = dirname(__filename); 82 | let paths: IPaths[] = []; 83 | this.logger.debug(`downloading ${this.verses.length} mp3 file.`); 84 | let promises = this.verses.map((verse, i) => { 85 | return async () => { 86 | let mp3 = `${verse.audio 87 | .url!.split("mp3")[1] 88 | .replace("/", "")}mp3`; 89 | let pathmp3 = join(__dirname, "..", "tmp", "audio", mp3); 90 | const verses_words = await this.getWords(); 91 | const ver = verses_words[i]; 92 | paths.push({ 93 | i: ver.id, 94 | font: parseInt(ver.words[0].p.replace("p", "")), 95 | name: pathmp3, 96 | words: ver.words, 97 | duration: verse.audio.duration!, 98 | }); 99 | this.logger.debug(mp3 + " downloading."); 100 | await downloadFile( 101 | `http://verses.quran.com/${verse.audio.url}`, 102 | pathmp3 103 | ); 104 | this.logger.debug(mp3 + " downloaded."); 105 | }; 106 | // FIX ME 107 | }); 108 | await new PQueue({ concurrency: 1 }).addAll(promises); 109 | this.logger.debug(`all ${this.verses.length} mp3 downloaded.`); 110 | // await Promise.all(promises); 111 | return paths; 112 | } 113 | } 114 | -------------------------------------------------------------------------------- /src/structures/Client.ts: -------------------------------------------------------------------------------- 1 | import PQueue from "p-queue"; 2 | import Editly, { Layer } from "editly"; 3 | import { upload } from "youtube-videos-uploader"; 4 | import { Credentials, Video } from "youtube-videos-uploader/dist/types"; 5 | import { executablePath, Touchscreen } from "puppeteer"; 6 | import fs from "fs/promises"; 7 | 8 | import { Api } from "."; 9 | import { Logger, get_font } from "../utils"; 10 | import { surahs } from "../constants"; 11 | import { ClientManager } from "./ClientManager"; 12 | import { IVerseImage } from "./api/verses/interfaces"; 13 | 14 | interface IBuildRes { 15 | name: string; 16 | description: string; 17 | surah: number; 18 | offset: number; 19 | } 20 | 21 | interface IUploadOptions { 22 | surah: number; 23 | offset: number; 24 | } 25 | 26 | export class Client { 27 | api = new Api(); 28 | logger: Logger; 29 | constructor({ debug }: { debug: boolean }) { 30 | this.logger = new Logger(debug); 31 | } 32 | 33 | async getRandomBackground() { 34 | const assets = await fs.readdir("assets"); 35 | return assets[Math.floor(Math.random() * assets.length)]; 36 | } 37 | 38 | async run({ 39 | surah, 40 | offset, 41 | recitation, 42 | }: { 43 | surah: number; 44 | offset: number; 45 | recitation: number; 46 | }) { 47 | console.log(surah, offset); 48 | if (surah > 114) { 49 | throw Error("Last surah is 114, you can't get beyond that."); 50 | } 51 | /** 52 | * "current" is length of the video 53 | * "page" verse count 54 | * verses 55 | */ 56 | let current = 0; // 57 | let page = 1; // verse number 58 | let verses: IVerseImage[] = []; // verses 59 | while (true) { 60 | /** 61 | * Get Image list 62 | * because Image has duration, and Words doesn't 63 | */ 64 | const list = await this.api.verses.get.list({ 65 | recitation: recitation, 66 | offset, 67 | limit: 1, 68 | page: page, 69 | type: "image", 70 | surah: surah, 71 | }); 72 | if (list.pagination.total_count < offset + page) { 73 | break; 74 | } 75 | let duration = list.verses[0].audio.duration ?? 0; 76 | if (duration + current >= 60) { 77 | if (verses.length > 0) { 78 | break; 79 | } 80 | offset = offset + 1; 81 | continue; 82 | } 83 | verses.push(list.verses[0]); 84 | page++; 85 | current += duration; 86 | } 87 | if (verses.length === 0) return false; 88 | 89 | /** 90 | * return client managuer class to process: 91 | * - download audio files (mp3) 92 | */ 93 | 94 | return new ClientManager( 95 | page, 96 | current, 97 | verses, 98 | surah, 99 | offset, 100 | this.logger 101 | ); 102 | } 103 | async build( 104 | offset: number, 105 | surah: number, 106 | i: number, 107 | recitation: number 108 | ): Promise { 109 | const downloader = await this.run({ surah: surah, offset, recitation }); 110 | if (downloader == false) { 111 | return await this.build(0, surah + 1, i, recitation); 112 | } 113 | let dont = false; 114 | 115 | const files = await downloader.download(); 116 | let total_duration = files 117 | .map((file) => file.duration) 118 | .reduce((prev, curr) => prev + curr); 119 | let start = 0; 120 | // TODO: add system of addition to be perfect 121 | let addition = 0.3; 122 | let with_addition = total_duration + files.length * addition; 123 | if (with_addition > 60) { 124 | dont = true; 125 | } 126 | let add = dont ? addition : addition; 127 | this.logger.debug( 128 | dont ? "there is no addition." : "there is addition", 129 | `with addition: ${with_addition}` 130 | ); 131 | /** 132 | * building the layers for PQueu so we can await them with same concurrency 133 | */ 134 | const layers = files 135 | .map((file) => { 136 | return async () => { 137 | // create text layer for Quran 138 | const text = { 139 | originX: "center", 140 | originY: "center", 141 | type: "title", 142 | // get, download and install the font 143 | fontPath: await get_font(file.font), 144 | text: file.words 145 | .map((word) => { 146 | let htmlEntity = word.code; 147 | let codePoint = 148 | htmlEntity.match(/x([\da-fA-F]+)/)![1]; 149 | let hexCode = codePoint.toUpperCase(); 150 | let character = String.fromCharCode( 151 | parseInt(hexCode, 16) 152 | ); 153 | return character; 154 | }) 155 | .join(" "), 156 | start: start, 157 | stop: start + file.duration - 0.1, 158 | } as Layer; 159 | // create voice layer of the (mp3) file 160 | const voice = { 161 | type: "detached-audio", 162 | start: start + add, 163 | stop: start + add + file.duration, 164 | path: file.name, 165 | } as Layer; 166 | start += file.duration; 167 | return [voice, text] as Layer[]; 168 | }; 169 | }) 170 | .flatMap((v) => v); 171 | /** 172 | * await all layers with same concurrency 173 | */ 174 | const lays = ( 175 | await new PQueue({ concurrency: 1 }).addAll(layers) 176 | ).flatMap((v) => v); 177 | /** 178 | * build video with Edily editor 179 | */ 180 | await Editly({ 181 | verbose: false, 182 | fast: this.logger.active, 183 | keepSourceAudio: false, 184 | outPath: `output.mp4`, 185 | height: 1920, 186 | width: 1080, 187 | defaults: { 188 | transition: null, 189 | }, 190 | clips: [ 191 | { 192 | duration: total_duration + files.length * add, 193 | layers: [ 194 | { 195 | type: "image-overlay", 196 | path: 197 | "assets/" + (await this.getRandomBackground()), 198 | }, 199 | ...lays, 200 | ], 201 | }, 202 | ], 203 | }); 204 | 205 | return { 206 | name: `${surahs[surah - 1].name}`, 207 | description: `${surahs[surah - 1].name}`, 208 | surah, 209 | offset: downloader.offset + files.length, 210 | }; 211 | } 212 | 213 | async upload(video: IBuildRes) { 214 | const credentials = { 215 | email: process.env.email, 216 | pass: process.env.password, 217 | recoveryemail: process.env.recoveryEmail || undefined, 218 | } as Credentials; 219 | 220 | const onVideoUploadSuccess = (videoUrls: string) => { 221 | console.log(videoUrls); 222 | }; 223 | 224 | const video1 = { 225 | path: `output.mp4`, 226 | title: video.name, 227 | description: "description 1", 228 | isNotForKid: true, 229 | onSuccess: onVideoUploadSuccess, 230 | skipProcessingWait: true, 231 | } as Video; 232 | await upload(credentials, [video1], { 233 | executablePath: executablePath(), 234 | }).then(console.log); 235 | } 236 | } 237 | -------------------------------------------------------------------------------- /src/constants/surah.ts: -------------------------------------------------------------------------------- 1 | export const surahs = [ 2 | { 3 | name: "al-Fātihah", 4 | pageGreen: 1, 5 | }, 6 | { 7 | name: "al-Baqarah", 8 | pageGreen: 2, 9 | }, 10 | { 11 | name: "Āl-ʿImrān", 12 | pageGreen: 50, 13 | }, 14 | { 15 | name: "an-Nisāʾ", 16 | pageGreen: 77, 17 | }, 18 | { 19 | name: "al-Māʾidah", 20 | pageGreen: 106, 21 | }, 22 | { 23 | name: "al-Anʿām", 24 | pageGreen: 128, 25 | }, 26 | { 27 | name: "al-Aʿrāf", 28 | pageGreen: 151, 29 | }, 30 | { 31 | name: "al-Anfāl", 32 | pageGreen: 177, 33 | }, 34 | { 35 | name: "at-Taubah", 36 | pageGreen: 187, 37 | }, 38 | { 39 | name: "Yūnus", 40 | pageGreen: 208, 41 | }, 42 | { 43 | name: "Hūd", 44 | pageGreen: 221, 45 | }, 46 | { 47 | name: "Yūsuf", 48 | pageGreen: 235, 49 | }, 50 | { 51 | name: "ar-Raʿd", 52 | pageGreen: 249, 53 | }, 54 | { 55 | name: "Ibrāhīm", 56 | pageGreen: 255, 57 | }, 58 | { 59 | name: "al-Ḥijr", 60 | pageGreen: 262, 61 | }, 62 | { 63 | name: "an-Naḥl", 64 | pageGreen: 267, 65 | }, 66 | { 67 | name: "al-Isrāʾ", 68 | pageGreen: 282, 69 | }, 70 | { 71 | name: "al-Kahf", 72 | pageGreen: 293, 73 | }, 74 | { 75 | name: "Maryam", 76 | pageGreen: 305, 77 | }, 78 | { 79 | name: "Ṭā-Hā", 80 | pageGreen: 312, 81 | }, 82 | { 83 | name: "al-Anbiyāʾ", 84 | pageGreen: 322, 85 | }, 86 | { 87 | name: "al-Ḥajj", 88 | pageGreen: 332, 89 | }, 90 | { 91 | name: "al-Muʾminūn", 92 | pageGreen: 342, 93 | }, 94 | { 95 | name: "an-Nūr", 96 | pageGreen: 350, 97 | }, 98 | { 99 | name: "al-Furqān", 100 | pageGreen: 359, 101 | }, 102 | { 103 | name: "ash-Shuʿarā", 104 | pageGreen: 367, 105 | }, 106 | { 107 | name: "an-Naml", 108 | pageGreen: 377, 109 | }, 110 | { 111 | name: "al-Qaṣaṣ", 112 | pageGreen: 385, 113 | }, 114 | { 115 | name: "al-ʿAnkabūt", 116 | pageGreen: 396, 117 | }, 118 | { 119 | name: "ar-Rūm", 120 | pageGreen: 404, 121 | }, 122 | { 123 | name: "Luqmān", 124 | pageGreen: 411, 125 | }, 126 | { 127 | name: "as-Sajdah", 128 | pageGreen: 415, 129 | }, 130 | { 131 | name: "al-Aḥzāb", 132 | pageGreen: 418, 133 | }, 134 | { 135 | name: "Sabaʾ", 136 | pageGreen: 428, 137 | }, 138 | { 139 | name: "Fāṭir", 140 | pageGreen: 434, 141 | }, 142 | { 143 | name: "Yā-Sīn", 144 | pageGreen: 440, 145 | }, 146 | { 147 | name: "as-Ṣāffāt", 148 | pageGreen: 446, 149 | }, 150 | { 151 | name: "Ṣād", 152 | pageGreen: 453, 153 | }, 154 | { 155 | name: "az-Zumar", 156 | pageGreen: 458, 157 | }, 158 | { 159 | name: "Ghāfir", 160 | pageGreen: 467, 161 | }, 162 | { 163 | name: "Fuṣṣilat", 164 | pageGreen: 477, 165 | }, 166 | { 167 | name: "ash-Shūrā", 168 | pageGreen: 483, 169 | }, 170 | { 171 | name: "az-Zukhruf", 172 | pageGreen: 489, 173 | }, 174 | { 175 | name: "ad-Dukhān", 176 | pageGreen: 496, 177 | }, 178 | { 179 | name: "al-Jāthiyah", 180 | pageGreen: 499, 181 | }, 182 | { 183 | name: "al-Aḥqāf", 184 | pageGreen: 502, 185 | }, 186 | { 187 | name: "Muḥammad", 188 | pageGreen: 507, 189 | }, 190 | { 191 | name: "al-Fatḥ", 192 | pageGreen: 511, 193 | }, 194 | { 195 | name: "al-Ḥujurāt", 196 | pageGreen: 515, 197 | }, 198 | { 199 | name: "Qāf", 200 | pageGreen: 518, 201 | }, 202 | { 203 | name: "adh-Dhāriyāt", 204 | pageGreen: 520, 205 | }, 206 | { 207 | name: "at-Ṭūr", 208 | pageGreen: 523, 209 | }, 210 | { 211 | name: "an-Najm", 212 | pageGreen: 526, 213 | }, 214 | { 215 | name: "al-Qamar", 216 | pageGreen: 528, 217 | }, 218 | { 219 | name: "ar-Raḥmān", 220 | pageGreen: 531, 221 | }, 222 | { 223 | name: "al-Wāqiʿah", 224 | pageGreen: 534, 225 | }, 226 | { 227 | name: "al-Ḥadīd", 228 | pageGreen: 537, 229 | }, 230 | { 231 | name: "al-Mujādilah", 232 | pageGreen: 542, 233 | }, 234 | { 235 | name: "al-Ḥashr", 236 | pageGreen: 545, 237 | }, 238 | { 239 | name: "al-Mumtaḥanah", 240 | pageGreen: 549, 241 | }, 242 | { 243 | name: "as-Ṣaff", 244 | pageGreen: 551, 245 | }, 246 | { 247 | name: "al-Jumuʿah", 248 | pageGreen: 553, 249 | }, 250 | { 251 | name: "al-Munāfiqūn", 252 | pageGreen: 554, 253 | }, 254 | { 255 | name: "at-Taghābun", 256 | pageGreen: 556, 257 | }, 258 | { 259 | name: "at-Ṭalāq", 260 | pageGreen: 558, 261 | }, 262 | { 263 | name: "at-Taḥrīm", 264 | pageGreen: 560, 265 | }, 266 | { 267 | name: "al-Mulk", 268 | pageGreen: 562, 269 | }, 270 | { 271 | name: "al-Qalam", 272 | pageGreen: 564, 273 | }, 274 | { 275 | name: "al-Ḥāqqah", 276 | pageGreen: 566, 277 | }, 278 | { 279 | name: "al-Maʿārij", 280 | pageGreen: 568, 281 | }, 282 | { 283 | name: "Nūḥ", 284 | pageGreen: 570, 285 | }, 286 | { 287 | name: "al-Jinn", 288 | pageGreen: 572, 289 | }, 290 | { 291 | name: "al-Muzzammil", 292 | pageGreen: 574, 293 | }, 294 | { 295 | name: "al-Muddaththir", 296 | pageGreen: 575, 297 | }, 298 | { 299 | name: "al-Qiyāmah", 300 | pageGreen: 577, 301 | }, 302 | { 303 | name: "al-Insān", 304 | pageGreen: 578, 305 | }, 306 | { 307 | name: "al-Mursalāt", 308 | pageGreen: 580, 309 | }, 310 | { 311 | name: "an-Nabaʾ", 312 | pageGreen: 582, 313 | }, 314 | { 315 | name: "an-Nāziʿāt", 316 | pageGreen: 583, 317 | }, 318 | { 319 | name: "ʿAbasa", 320 | pageGreen: 585, 321 | }, 322 | { 323 | name: "at-Takwīr", 324 | pageGreen: 586, 325 | }, 326 | { 327 | name: "al-Infiṭār", 328 | pageGreen: 587, 329 | }, 330 | { 331 | name: "al-Muṭaffifīn", 332 | pageGreen: 587, 333 | }, 334 | { 335 | name: "al-Inshiqāq", 336 | pageGreen: 589, 337 | }, 338 | { 339 | name: "al-Burūj", 340 | pageGreen: 590, 341 | }, 342 | { 343 | name: "at-Ṭāriq", 344 | pageGreen: 591, 345 | }, 346 | { 347 | name: "al-Aʿlā", 348 | pageGreen: 591, 349 | }, 350 | { 351 | name: "al-Ghāshiyah", 352 | pageGreen: 592, 353 | }, 354 | { 355 | name: "al-Fajr", 356 | pageGreen: 593, 357 | }, 358 | { 359 | name: "al-Balad", 360 | pageGreen: 594, 361 | }, 362 | { 363 | name: "ash-Shams", 364 | pageGreen: 595, 365 | }, 366 | { 367 | name: "al-Layl", 368 | pageGreen: 595, 369 | }, 370 | { 371 | name: "ad-Ḍuḥā", 372 | pageGreen: 596, 373 | }, 374 | { 375 | name: "ash-Sharḥ", 376 | pageGreen: 596, 377 | }, 378 | { 379 | name: "at-Tīn", 380 | pageGreen: 597, 381 | }, 382 | { 383 | name: "al-ʿAlaq", 384 | pageGreen: 597, 385 | }, 386 | { 387 | name: "al-Qadr", 388 | pageGreen: 598, 389 | }, 390 | { 391 | name: "al-Bayyinah", 392 | pageGreen: 598, 393 | }, 394 | { 395 | name: "az-Zalzalah", 396 | pageGreen: 599, 397 | }, 398 | { 399 | name: "al-ʿĀdiyāt", 400 | pageGreen: 599, 401 | }, 402 | { 403 | name: "al-Qāriʿah", 404 | pageGreen: 600, 405 | }, 406 | { 407 | name: "at-Takāthur", 408 | pageGreen: 600, 409 | }, 410 | { 411 | name: "al-ʿAsr", 412 | pageGreen: 601, 413 | }, 414 | { 415 | name: "al-Humazah", 416 | pageGreen: 601, 417 | }, 418 | { 419 | name: "al-Fīl", 420 | pageGreen: 601, 421 | }, 422 | { 423 | name: "Quraysh", 424 | pageGreen: 602, 425 | }, 426 | { 427 | name: "al-Māʿūn", 428 | pageGreen: 602, 429 | }, 430 | { 431 | name: "al-Kawthar", 432 | pageGreen: 602, 433 | }, 434 | { 435 | name: "al-Kāfirūn", 436 | pageGreen: 603, 437 | }, 438 | { 439 | name: "an-Naṣr", 440 | pageGreen: 603, 441 | }, 442 | { 443 | name: "al-Masad", 444 | pageGreen: 603, 445 | }, 446 | { 447 | name: "al-Ikhlāṣ", 448 | pageGreen: 604, 449 | }, 450 | { 451 | name: "al-Falaq", 452 | pageGreen: 604, 453 | }, 454 | { 455 | name: "an-Nās", 456 | pageGreen: 604, 457 | }, 458 | ] as const; 459 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------