├── session └── .keep ├── downloads └── .keep ├── log_files └── .keep ├── src ├── types │ ├── OptionsProgram.ts │ └── FfmpegCmd.ts ├── types.d.ts ├── tiktok │ ├── types │ │ ├── StreamData.ts │ │ ├── TikTokCookieInterface.ts │ │ └── WebCastTikTokApiInterface.ts │ ├── matchRoomId.ts │ ├── constants.ts │ ├── fetchHTML.ts │ └── api │ │ ├── getWebCastTikTokApiResponse.ts │ │ └── getStreamData.ts ├── shared │ ├── sanitizeUsername.ts │ └── saveInfoToFile.ts ├── cookies │ ├── loadCookie.ts │ ├── evaluateCookie.ts │ ├── createCookie.ts │ └── saveCookie.ts ├── ffmpeg │ ├── runFfmpeg.ts │ └── ffmpegArgs.ts ├── cli │ └── index.ts └── core │ ├── buildOutputName.ts │ └── downloadLiveStream.ts ├── AUTHORS ├── .vscode ├── extensions.json └── settings.json ├── .gitignore ├── package.json ├── tsconfig.json ├── README.md └── LICENSE /session/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /downloads/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /log_files/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/types/OptionsProgram.ts: -------------------------------------------------------------------------------- 1 | export interface OptionsProgram { 2 | output: string 3 | format: string 4 | debug: boolean 5 | } 6 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | # Author 2 | Lucas <@loo-kuhs> (https://github.com/loo-kuhs) 3 | 4 | # Original Repository: 5 | Paulo <@Pauloo27> (https://github.com/Pauloo27/tiktok-live) -------------------------------------------------------------------------------- /src/types.d.ts: -------------------------------------------------------------------------------- 1 | declare module 'commander' 2 | declare module 'fs' 3 | declare module 'path' 4 | declare module 'child_process' 5 | declare module 'puppeteer' 6 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "ms-vscode.vscode-typescript-next", 4 | "MariusAlchimavicius.json-to-ts", 5 | "pmneo.tsimporter", 6 | "wix.vscode-import-cost" 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /src/types/FfmpegCmd.ts: -------------------------------------------------------------------------------- 1 | export interface FfmpegEvents { 2 | progress: (rawLine: string) => void 3 | exit: (code: number | null) => void 4 | error: (error: Error) => void 5 | } 6 | 7 | export interface FfmpegCmd { 8 | cmd: string 9 | args: string[] 10 | } 11 | -------------------------------------------------------------------------------- /src/tiktok/types/StreamData.ts: -------------------------------------------------------------------------------- 1 | export interface StreamData { 2 | url: string 3 | title: string 4 | user: string 5 | statusOnline: number 6 | isFlv: boolean 7 | } 8 | 9 | export interface StreamInfo { 10 | liveUrl: string 11 | liveTitle: string 12 | liveUser: string 13 | liveStatus: number 14 | } 15 | -------------------------------------------------------------------------------- /src/shared/sanitizeUsername.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * It takes a string, checks if it starts with an @ symbol, and if it does, it returns the string 3 | * without the @ symbol 4 | * @param {string} username - The username to sanitize 5 | * @returns {string} string - The username without the @ symbol. 6 | */ 7 | export const sanitizeUsername = (username: string): string => { 8 | return username.startsWith('@') ? username.substring(1) : username 9 | } 10 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "cSpell.words": [ 3 | "aigc", 4 | "ecommerce", 5 | "faststart", 6 | "keyint", 7 | "KHTML", 8 | "libx", 9 | "loglevel", 10 | "matroska", 11 | "moov", 12 | "movflags", 13 | "mrbeast", 14 | "mydownloads", 15 | "networkidle", 16 | "nostats", 17 | "nostdin", 18 | "Pauloo", 19 | "scenecut", 20 | "tiktok", 21 | "winget" 22 | ], 23 | "typescript.tsdk": "node_modules\\typescript\\lib" 24 | } -------------------------------------------------------------------------------- /src/tiktok/matchRoomId.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Extracts the room id from the HTML body of the TikTok live stream page. 3 | * 4 | * @param {string} extractedHTML - The HTML body of the TikTok live stream page. 5 | * @return {string} - The room id of the live stream. 6 | */ 7 | function matchRoomId(extractedHTML: string): string { 8 | const liveRoomId = extractedHTML.match(/"roomId":"(\d+)"/) // "roomId":"7392776838324325xxx -- before: /room_id=(\d+)/ 9 | 10 | if (!liveRoomId) { 11 | throw new Error('❌ No room id found!') 12 | } 13 | 14 | console.info(`\n✅ Found room id: ${liveRoomId[1]}! 🎉`) 15 | return liveRoomId[1] 16 | } 17 | 18 | export default matchRoomId 19 | -------------------------------------------------------------------------------- /src/tiktok/types/TikTokCookieInterface.ts: -------------------------------------------------------------------------------- 1 | export default interface TiktokCookie { 2 | name: string 3 | value: string 4 | domain: Domain 5 | path: Path 6 | expires: number 7 | size: number 8 | httpOnly: boolean 9 | secure: boolean 10 | session: boolean 11 | priority: Priority 12 | sameParty: boolean 13 | sourceScheme: SourceScheme 14 | sourcePort: number 15 | sameSite?: string 16 | } 17 | 18 | enum Domain { 19 | DomainWWWTiktokCOM = 'www.tiktok.com', 20 | TiktokCOM = '.tiktok.com', 21 | WWWTiktokCOM = '.www.tiktok.com', 22 | } 23 | 24 | enum Path { 25 | Empty = '/', 26 | } 27 | 28 | enum Priority { 29 | Medium = 'Medium', 30 | } 31 | 32 | enum SourceScheme { 33 | Secure = 'Secure', 34 | } 35 | -------------------------------------------------------------------------------- /src/cookies/loadCookie.ts: -------------------------------------------------------------------------------- 1 | import { readFileSync } from 'fs' 2 | import TiktokCookie from '../tiktok/types/TikTokCookieInterface' 3 | 4 | export function loadCookie(): TiktokCookie[] { 5 | let cookiesData = readFileSync(`./session/cookie.txt`, 'utf8') 6 | let cookiesArray: TiktokCookie[] = JSON.parse(cookiesData) 7 | 8 | return cookiesArray 9 | } 10 | 11 | export function cookieToString(cookies: TiktokCookie[]): string { 12 | let cookiesArray = cookies 13 | 14 | let cookieString = cookiesArray 15 | .map( 16 | (cookie: { name: string; value: string }) => 17 | `${cookie.name}=${cookie.value}` 18 | ) 19 | .join('; ') 20 | 21 | console.info(`\n🍪 Cookie string created.`) 22 | 23 | return cookieString 24 | } 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | package-lock.json 6 | 7 | # Runtime data 8 | pids 9 | *.pid 10 | *.seed 11 | 12 | # Directory for instrumented libs generated by jscoverage/JSCover 13 | lib-cov 14 | 15 | # Coverage directory used by tools like istanbul 16 | coverage 17 | .nyc_output 18 | coverage.* 19 | 20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 21 | .grunt 22 | 23 | # node-waf configuration 24 | .lock-wscript 25 | 26 | # Compiled binary addons (http://nodejs.org/api/addons.html) 27 | build/Release 28 | build/* 29 | 30 | # Dependency directory 31 | node_modules 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional REPL history 37 | .node_repl_history 38 | 39 | typings/ 40 | lib/*.js 41 | test/*.js 42 | *.map 43 | 44 | # Video files 45 | *.mp4 46 | *.mkv 47 | 48 | # Text files 49 | *.txt 50 | *.log -------------------------------------------------------------------------------- /src/ffmpeg/runFfmpeg.ts: -------------------------------------------------------------------------------- 1 | import EventEmitter from 'node:events' 2 | import { FfmpegCmd, FfmpegEvents } from '../types/FfmpegCmd' 3 | import { spawn } from 'node:child_process' 4 | 5 | export const runFfmpeg = ({ 6 | cmd, 7 | args, 8 | }: FfmpegCmd): EventEmitter & FfmpegEvents => { 9 | const emitter = new EventEmitter() as unknown as EventEmitter & 10 | Record void> 11 | 12 | const proc = spawn(cmd, args, { stdio: ['ignore', 'pipe', 'pipe'] }) 13 | 14 | proc.stderr.setEncoding('utf8') 15 | proc.stderr.on('data', (chunk) => { 16 | process.stderr.write(chunk) 17 | emitter.emit('progress', chunk) 18 | }) 19 | 20 | proc.on('exit', (code) => { 21 | emitter.emit('exit', code) 22 | }) 23 | 24 | proc.on('error', (error) => { 25 | process.stderr.write(`❌ Error: ${error.message}\n`) 26 | emitter.emit('error', error) 27 | }) 28 | 29 | return emitter 30 | } 31 | -------------------------------------------------------------------------------- /src/cookies/evaluateCookie.ts: -------------------------------------------------------------------------------- 1 | import { existsSync } from 'fs' 2 | import saveCookie from './saveCookie' 3 | import { cookieToString, loadCookie } from './loadCookie' 4 | 5 | async function evaluateCookie(): Promise { 6 | const currentTimeUnix: number = Math.floor(Date.now() / 1000) 7 | 8 | if (!existsSync('./session/cookie.txt')) { 9 | console.info(`\n🍪 Cookie file not found. Creating new cookie.`) 10 | await saveCookie() 11 | } 12 | 13 | const cookiesArray = loadCookie() 14 | console.info(`\n🍪 Cookie loaded. Evaluating cookie...`) 15 | 16 | const isExpired = cookiesArray.some((cookie) => { 17 | if (cookie.name === 'msToken' && cookie.domain === 'www.tiktok.com') { 18 | return cookie.expires < currentTimeUnix 19 | } 20 | return false 21 | }) 22 | 23 | if (isExpired) { 24 | console.info(`\n🍪 Cookie is expired. Creating new cookie.`) 25 | saveCookie() 26 | } 27 | 28 | const cookieString = cookieToString(loadCookie()) 29 | 30 | return cookieString 31 | } 32 | 33 | export default evaluateCookie 34 | -------------------------------------------------------------------------------- /src/tiktok/constants.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Constant for User-Agent header. It is used to make requests to the TikTok API. 3 | */ 4 | export const TIKTOK_UA: string = 5 | 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' 6 | 7 | /** 8 | * It takes a string as an argument and returns a string 9 | * @param {string} username - The username of the TikTok account you want to get the live URL for. 10 | * @returns {string} string - The live URL of the TikTok account. 11 | */ 12 | 13 | export const newLiveUrl = (username: string): string => { 14 | return `https://www.tiktok.com/@${username}/live` 15 | } 16 | 17 | /** 18 | * It takes a roomId as an argument and returns a string 19 | * @param {string} roomId - The room ID of the TikTok live stream. 20 | * @returns {string} string - The TikTok Webcast API URL for the given room ID. 21 | */ 22 | 23 | export const TIKTOK_WEBCAST_API = (roomId: string): string => { 24 | return `https://webcast.tiktok.com/webcast/room/info/?aid=1988&room_id=${roomId}` 25 | } 26 | -------------------------------------------------------------------------------- /src/cli/index.ts: -------------------------------------------------------------------------------- 1 | import { Command } from 'commander' 2 | import { OptionsProgram } from '@app-types/OptionsProgram' 3 | import { downloadLiveStream } from '@app-core/downloadLiveStream' 4 | 5 | const program = new Command() 6 | 7 | program 8 | .argument('', 'Username of tiktok user') 9 | .description('Download tiktok live stream') 10 | .option( 11 | '-o, --output [path]', 12 | `Output file or folder path (eg ./folder or ./folder/file.mp4)`, 13 | `downloads` 14 | ) 15 | .option('-f, --format ', 'Output formats valid mp4 and mkv', 'mkv') 16 | .option('-d, --debug', 'output extra debugging') 17 | .action((username: string, options: OptionsProgram) => { 18 | const { output, format }: OptionsProgram = options 19 | 20 | console.info(`\n🔎 Searching ${username}'s live stream`) 21 | console.info(`💾 Output directory: ${output}`) 22 | console.info(`📹 Format video: ${format}`) 23 | 24 | downloadLiveStream(username, output, format).catch((err) => { 25 | console.error(err) 26 | process.exit(1) 27 | }) 28 | }) 29 | 30 | program.parse(process.argv) 31 | -------------------------------------------------------------------------------- /src/cookies/createCookie.ts: -------------------------------------------------------------------------------- 1 | import { launch } from 'puppeteer' 2 | import TiktokCookie from '../tiktok/types/TikTokCookieInterface' 3 | 4 | async function createCookie(): Promise { 5 | console.info(`\n🍪 Creating cookie for API authentication...`) 6 | try { 7 | console.info(`\n🚀 Launching puppeteer to retrieve session cookie...`) 8 | 9 | const browser = await launch({ 10 | headless: true, 11 | args: ['--no-sandbox', '--disable-setuid-sandbox'], 12 | }) 13 | const page = await browser.newPage() 14 | 15 | await page.goto('https://www.tiktok.com/live', { 16 | waitUntil: ['domcontentloaded', 'networkidle2'], 17 | }) 18 | 19 | const client = await page.target().createCDPSession() 20 | const cookies = (await client.send('Network.getAllCookies')).cookies 21 | 22 | await browser.close() 23 | 24 | console.info(`\n✅ Cookie successfully created for API usage.`) 25 | 26 | return cookies 27 | } catch (error) { 28 | throw new Error(`❌ Failed to create cookie. Error: ${error}`).message 29 | } 30 | } 31 | 32 | export default createCookie 33 | -------------------------------------------------------------------------------- /src/tiktok/fetchHTML.ts: -------------------------------------------------------------------------------- 1 | import puppeteer from 'puppeteer' 2 | import { TIKTOK_UA } from "./constants" 3 | 4 | /** 5 | * Fetches the HTML content from the specified URL. 6 | * @param {string} url - The URL to fetch the HTML from 7 | * @returns {Promise} - A promise that resolves to the HTML content as a string 8 | */ 9 | export default async function fetchHTML( 10 | url: string 11 | ): Promise { 12 | console.warn( 13 | `\n⛔ Tiktok WAF detected. Don't worry, we will use Puppeteer to fetch the HTML!` 14 | ) 15 | 16 | const newBrowser = await puppeteer.launch({ 17 | headless: 'new', 18 | args: ['--no-sandbox', '--disable-setuid-sandbox'], 19 | /* headless: false, */ 20 | }) 21 | 22 | const page = await newBrowser.newPage() 23 | 24 | await page.setUserAgent(TIKTOK_UA) 25 | 26 | await page.goto(url, { waitUntil: 'networkidle2', timeout: 60000 }) 27 | 28 | const html: string = await page.content() 29 | await newBrowser.close() 30 | 31 | console.info(`\n✅ Done! HTML fetched successfully.`) 32 | console.info(`\n✅ ${html.length} bytes fetched from ${url}`) 33 | 34 | return html 35 | } 36 | -------------------------------------------------------------------------------- /src/cookies/saveCookie.ts: -------------------------------------------------------------------------------- 1 | import { join } from 'path' 2 | import createCookie from './createCookie' 3 | import { existsSync, mkdirSync, writeFileSync } from 'fs' 4 | 5 | async function saveCookie(): Promise { 6 | try { 7 | const sessionDir = join(process.cwd(), 'session') 8 | const cookieFilePath = join(sessionDir, 'cookie.txt') 9 | 10 | if (!existsSync(sessionDir)) { 11 | console.info(`\n📁 Directory not found. Creating 'session' directory...`) 12 | mkdirSync(sessionDir, { recursive: true }) 13 | console.info(`\n📁 Directory 'session' created successfully.`) 14 | } 15 | 16 | const newCookie = await createCookie() 17 | const cookieString = JSON.stringify(newCookie, null, 2) 18 | 19 | console.info(`\n📝 Saving cookie to '${cookieFilePath}'`) 20 | 21 | writeFileSync(cookieFilePath, cookieString, { encoding: 'utf8' }) 22 | 23 | console.info(`\n✅ Cookie successfully saved to file: ${cookieFilePath}`) 24 | } catch (error) { 25 | console.error(`\n❌ Error saving the cookie: ${error}`) 26 | throw new Error('Failed to save cookie.') 27 | } 28 | } 29 | 30 | export default saveCookie 31 | -------------------------------------------------------------------------------- /src/tiktok/api/getWebCastTikTokApiResponse.ts: -------------------------------------------------------------------------------- 1 | import { WebCastTikTokApiResponse } from '../types/WebCastTikTokApiInterface' 2 | import { TIKTOK_WEBCAST_API } from '../constants' 3 | import { TIKTOK_UA } from "../constants" 4 | 5 | /** 6 | * It takes a roomId, makes a request to the tiktok api, and returns the response. 7 | * 8 | * @param {string} roomId - The room ID of the live stream. 9 | * @param {string} cookie - The cookie to be able to make the request. 10 | * @return {Promise} - The response from the tiktok api. 11 | */ 12 | async function getWebCastTikTokApiResponse( 13 | roomId: string, 14 | cookie: string 15 | ): Promise { 16 | const api = TIKTOK_WEBCAST_API(roomId) 17 | const response = await fetch(api, { 18 | headers: { 19 | cookie: cookie, 20 | 'User-Agent': TIKTOK_UA, 21 | }, 22 | }) 23 | 24 | const data = await response.json() 25 | const tiktokResponse: WebCastTikTokApiResponse = { 26 | data: data.data, 27 | extra: data.extra, 28 | status_code: data.status, 29 | } 30 | 31 | return tiktokResponse 32 | } 33 | 34 | export default getWebCastTikTokApiResponse 35 | -------------------------------------------------------------------------------- /src/core/buildOutputName.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * It takes a string as an argument and returns a string. 3 | * 4 | * @param {string} output - The output path for the downloaded live stream. 5 | * @param {string} username - The username of the TikTok account. 6 | * @param {string} format - The format of the downloaded live stream. 7 | * @returns {string} string - The name of the file to save the live stream to. 8 | */ 9 | 10 | export const buildOutputName = ( 11 | output: string, 12 | username: string, 13 | format: string 14 | ): string => { 15 | const now = new Date() 16 | 17 | const d: string = now.getDate().toString() 18 | const M: string = (now.getMonth() + 1).toString() 19 | const Y: string = now.getFullYear().toString() 20 | 21 | const HH: string = String(now.getHours()).padStart(2, '0') 22 | const mm: string = String(now.getMinutes()).padStart(2, '0') 23 | const ss: string = String(now.getSeconds()).padStart(2, '0') 24 | 25 | const sanitizedOutput: string = output.endsWith('/') 26 | ? output.slice(0, -1) 27 | : output 28 | 29 | const timeStamp: string = `${d}${M}${Y}${HH}${mm}${ss}` 30 | const outputName: string = `${sanitizedOutput}/${username}-${timeStamp}.${format}` 31 | 32 | return outputName 33 | } 34 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tiktok-live-ts", 3 | "version": "2.0.0.0", 4 | "description": "A TypeScript nodejs application to download live streams from TikTok by the shared URL.", 5 | "main": "app.js", 6 | "scripts": { 7 | "build": "tsc", 8 | "esbuild": "esbuild ./src/cli/index.ts --bundle --platform=node --outfile=build/cli.js --alias:@app-cli=src/cli --alias:@app-core=src/core --alias:@app-ffmpeg=src/ffmpeg --alias:@app-cookies=src/cookies --alias:@app-tiktok=src/tiktok --alias:@app-shared=src/shared --alias:@app-types=src/types", 9 | "start": "node build/app.js", 10 | "clear": "rimraf build" 11 | }, 12 | "bin": { 13 | "download": "./build/app.js download" 14 | }, 15 | "keywords": [ 16 | "tiktok", 17 | "live", 18 | "api", 19 | "tiktok-live", 20 | "tiktok-live-ts" 21 | ], 22 | "author": { 23 | "name": "Lucas", 24 | "github": "@loo-kuhs", 25 | "url": "https://github.com/loo-kuhs/tiktok-live-downloader" 26 | }, 27 | "license": "GPL-3.0", 28 | "devDependencies": { 29 | "@types/node": "^22.15.3", 30 | "@types/shelljs": "^0.8.15", 31 | "@types/web": "^0.0.228", 32 | "esbuild": "^0.25.5", 33 | "tsconfig-paths": "^4.2.0", 34 | "tsx": "^4.19.4", 35 | "typescript": "^5.8.3" 36 | }, 37 | "dependencies": { 38 | "commander": "^13.1.0", 39 | "puppeteer": "^24.7.2" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/shared/saveInfoToFile.ts: -------------------------------------------------------------------------------- 1 | import { appendFileSync, existsSync, mkdirSync } from 'fs' 2 | import { join } from 'path' 3 | 4 | /**+ 5 | * Dev function to save data to a file. 6 | * It creates a directory called 'log_files' if it doesn't exist and saves the data to a file with a timestamp. 7 | * @param {string} filename - The name of the file to save the data to. 8 | * @param {string | object | number | boolean} data - The data to save to the file. 9 | * @returns {Promise} - A promise that resolves when the data has been saved to the file. 10 | */ 11 | export default async function saveInfoToFile( 12 | filename: string, 13 | data: string | object | number | boolean 14 | ): Promise { 15 | try { 16 | const timestamp = new Date().toISOString().replace(/:/g, '') 17 | const formattedDate = timestamp.split('T')[0].replace(/-/g, '') 18 | const formattedFilename = `${filename}-${formattedDate}.log` 19 | 20 | const currentDir = join(process.cwd(), 'log_files') 21 | const filePath = join(currentDir, formattedFilename) 22 | 23 | if (!existsSync(currentDir)) { 24 | console.info( 25 | `\n📁 Directory not found. Creating 'log_files' directory...` 26 | ) 27 | mkdirSync(currentDir, { recursive: true }) 28 | console.info(`\n📁 Directory 'log_files' created successfully.`) 29 | } 30 | 31 | console.info(`\n💾 Saving data to '${filePath}'`) 32 | 33 | const fileContent = `\n# ${formattedFilename}\n${manageDataByType(data)}` 34 | 35 | appendFileSync(filePath, fileContent + '\n', { encoding: 'utf8' }) 36 | 37 | console.info(`\n✅ Data successfully saved to file: ${filePath}`) 38 | } catch (error) { 39 | console.error(`\n❌ Error saving the file: ${error}`) 40 | throw new Error('Failed to save file.') 41 | } 42 | } 43 | 44 | function manageDataByType(data: any): string { 45 | if (typeof data === 'string') { 46 | return data 47 | } else if (typeof data === 'object') { 48 | return JSON.stringify(data, null, 2) 49 | } else { 50 | return String(data) 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* === Paths ============================== */ 4 | "baseUrl": "." /* Base directory to resolve non-relative module names. */, 5 | "paths": { 6 | /* Map module names to locations relative to the baseUrl. */ 7 | "@app-cli/*": ["src/cli/*"], 8 | "@app-core/*": ["src/core/*"], 9 | "@app-ffmpeg/*": ["src/ffmpeg/*"], 10 | "@app-cookies/*": ["src/cookies/*"], 11 | "@app-tiktok/*": ["src/tiktok/*"], 12 | "@app-shared/*": ["src/shared/*"], 13 | "@app-types/*": ["src/types/*"] 14 | }, 15 | /* === Language / Environment / Modules ============================== */ 16 | "target": "es2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, 17 | "module": "esnext" /* Specify what module code is generated. */, 18 | "moduleResolution": "Node" /* Specify how TypeScript looks up a file from a given module specifier. */, 19 | "rootDir": "src" /* Specify the root folder within your source files. */, 20 | "outDir": "build" /* Specify an output folder for all emitted files. */, 21 | 22 | /* === Emit / Helpers ============================== */ 23 | "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */, 24 | "sourceMap": true /* Create source map files for emitted JavaScript files. */, 25 | 26 | /* === Interop & Safety ============================== */ 27 | "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, 28 | "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, 29 | "strict": true /* Enable all strict type-checking options. */, 30 | "skipLibCheck": true /* Skip type checking all .d.ts files. */ 31 | 32 | }, 33 | "exclude": [ 34 | "node_modules" /* Exclude folder from compilation. */, 35 | "build" /* Exclude folder from compilation. */, 36 | "downloads" /* Exclude folder from compilation. */ 37 | ] 38 | } 39 | -------------------------------------------------------------------------------- /src/tiktok/api/getStreamData.ts: -------------------------------------------------------------------------------- 1 | import getWebCastTikTokApiResponse from './getWebCastTikTokApiResponse' 2 | import { StreamData, StreamInfo } from '../types/StreamData' 3 | 4 | /** 5 | * It creates the stream data object with the stream url, title, user, status online, and if it's flv. 6 | * 7 | * @export 8 | * @param {string} roomId - The room ID of the live stream. 9 | * @return {Promise} - The StreamData object. 10 | * @throws {Error} - If the live stream url is empty or the user is offline. 11 | */ 12 | export default async function setStreamData( 13 | roomId: string, 14 | cookie: string 15 | ): Promise { 16 | const [flvInfo] = await Promise.all([getStreamInfo(roomId, cookie, 'FLV')]) 17 | const onlineStatus = 2 18 | 19 | if (!flvInfo.liveUrl) { 20 | throw new Error(`\n❌ The user is offline or the live stream url is empty!`) 21 | } 22 | 23 | if (flvInfo.liveUrl && flvInfo.liveStatus === onlineStatus) { 24 | console.info(`\n✅ Found ${flvInfo.liveUser} live stream url! 🎉`) 25 | return { 26 | url: flvInfo.liveUrl, 27 | title: flvInfo.liveTitle, 28 | user: flvInfo.liveUser, 29 | statusOnline: flvInfo.liveStatus, 30 | isFlv: true, 31 | } 32 | } 33 | 34 | throw new Error( 35 | `\n❌ No url live stream found! This user is offline or the live url is empty.\n` 36 | ).message 37 | } 38 | 39 | async function getStreamInfo( 40 | roomId: string, 41 | cookie: string, 42 | type: 'FLV' 43 | ): Promise { 44 | let response = await getWebCastTikTokApiResponse(roomId, cookie) 45 | 46 | // Verify if we got a valid response 47 | if ('prompts' in response.data) { 48 | throw new Error( 49 | `\n❌ The live stream is not available! Use a logged-in account to watch it.` 50 | ).message 51 | } 52 | 53 | // Verify Age restriction 54 | if (response.data.age_restricted.AgeInterval === 4) { 55 | console.info( 56 | `\n⚠️ This live stream is age-restricted (code 4)! You must need a logged-in account to watch it.` 57 | ) 58 | } 59 | 60 | return { 61 | liveUrl: 62 | response.data.stream_url.flv_pull_url.FULL_HD1 || 63 | response.data.stream_url.flv_pull_url.HD1, 64 | liveTitle: response.data.title, 65 | liveUser: response.data.owner.nickname, 66 | liveStatus: response.data.status, 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # TikTok Live Stream Downloader 2 | 3 | This is a refactored version of [tiktok-live](https://github.com/Pauloo27/tiktok-live) by [Pauloo27](https://github.com/Pauloo27). 4 | 5 | ## Project Status 6 | 7 | This project is currently in development. Before open a issue, please read all the requirements, installation and usage section. 8 | 9 | > ![GitHub top language](https://img.shields.io/github/languages/top/loo-kuhs/tiktok-live-downloader?style=for-the-badge) 10 | > ![GitHub last commit](https://img.shields.io/github/last-commit/loo-kuhs/tiktok-live-downloader?style=for-the-badge) 11 | > ![GitHub repo size](https://img.shields.io/github/repo-size/loo-kuhs/tiktok-live-downloader?style=for-the-badge) 12 | > ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/loo-kuhs/tiktok-live-downloader?style=for-the-badge) 13 | 14 | ## ☕ Support Me on Ko-fi 15 | 16 | Found this tool helpful? That’s awesome — I’m glad it helped! 17 | If you'd like to support future updates or just say thanks, you can optionally buy me a coffee: 18 | 19 | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A81ENILS) 20 | 21 | ## Installation 22 | 23 | ### Requirements 24 | 25 | This project requires ffmpeg to be installed on your system. You can download it from [the official ffmpeg website](https://ffmpeg.org/download.html). 26 | 27 | This project uses native fetch, so you need to have Node.js 18.0.0 or higher installed on your system. You can download it from [the official Node.js downloads page](https://nodejs.org/en/download/). 28 | 29 | **Install ffmpeg on Windows:** 30 | 31 | ```bash 32 | choco install ffmpeg-full 33 | # or 34 | scoop install ffmpeg 35 | # or 36 | winget install ffmpeg 37 | ``` 38 | 39 | **Install ffmpeg on Linux:** 40 | 41 | ```bash 42 | sudo apt install ffmpeg 43 | ``` 44 | 45 | **Install ffmpeg on MacOS:** 46 | 47 | ```bash 48 | brew install ffmpeg 49 | ``` 50 | 51 | ## Usage 52 | 53 | Clone the repository: 54 | 55 | ```bash 56 | git clone https://github.com/loo-kuhs/tiktok-live-downloader.git 57 | ``` 58 | 59 | Install dependencies: 60 | 61 | ```bash 62 | npm install 63 | ``` 64 | 65 | Build the project: 66 | 67 | ```bash 68 | npm run esbuild 69 | ``` 70 | 71 | Run the project: 72 | 73 | ```bash 74 | node build/cli.js --output --format 75 | # or 76 | node build/cli.js -o -f 77 | # or 78 | node build/cli.js -o 79 | # or 80 | node build/cli.js -f 81 | # e.g. 82 | node build/cli.js mrbeast --output mydownloads --format mp4 83 | ``` 84 | 85 | > **Note:** Last tested into Windows 11 with Node.js 22.14.0, npm 11.4.0 and ffmpeg 7.1.1-full_build. 86 | 87 | ## Open Issues 88 | 89 | Before open a issue, please read all the requirements, installation and usage section. 90 | If you have any questions, please open a issue answering the following questions: 91 | 92 | - What is the problem? (Please describe and provide logs and/or screenshots) 93 | - What version of Node.js and npm are you using? 94 | - What operating system are you using? 95 | - Are you using the latest version of the project? 96 | - Did you follow all the requirements, installation and usage section? 97 | - Did you try to run the project on another operating system/environment? 98 | 99 | ## Contributing 100 | 101 | Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 102 | 103 | Thanks to [Pauloo27](https://github.com/Pauloo27) for the original project code base. 104 | -------------------------------------------------------------------------------- /src/core/downloadLiveStream.ts: -------------------------------------------------------------------------------- 1 | import evaluateCookie from '@app-cookies/evaluateCookie' 2 | import { ffmpegCommandMKV, ffmpegCommandMP4 } from '@app-ffmpeg/ffmpegArgs' 3 | import { runFfmpeg } from '@app-ffmpeg/runFfmpeg' 4 | import { sanitizeUsername } from '@app-shared/sanitizeUsername' 5 | import setStreamData from '@app-tiktok/api/getStreamData' 6 | import { newLiveUrl } from '@app-tiktok/constants' 7 | import fetchHTML from '@app-tiktok/fetchHTML' 8 | import matchRoomId from '@app-tiktok/matchRoomId' 9 | import { StreamData } from '@app-tiktok/types/StreamData' 10 | import { FfmpegEvents } from '@app-types/FfmpegCmd' 11 | import EventEmitter from 'events' 12 | import fs from 'fs' 13 | import path from 'path' 14 | import { buildOutputName } from './buildOutputName' 15 | 16 | export async function downloadLiveStream( 17 | username: string, 18 | output: string, 19 | format: string 20 | ): Promise { 21 | const emitter = new EventEmitter() as EventEmitter & FfmpegEvents 22 | 23 | if (!username) { 24 | throw new Error(`❌ The username is empty!`).message 25 | } 26 | 27 | const acceptedFormats: string[] = ['mp4', 'mkv'] 28 | 29 | if (!acceptedFormats.includes(format)) { 30 | throw new Error( 31 | `❌ The format ${format} is not valid! Please use mp4 or mkv.` 32 | ).message 33 | } 34 | 35 | try { 36 | const sanitizedUsername: string = sanitizeUsername(username) 37 | const liveUrl: string = newLiveUrl(sanitizedUsername) 38 | const myCookie: string = await evaluateCookie() 39 | const profileHTML: string = await fetchHTML(liveUrl) 40 | const roomId: string = matchRoomId(profileHTML) 41 | 42 | const [streamData]: [StreamData] = await Promise.all([ 43 | setStreamData(roomId, myCookie), 44 | ]) 45 | 46 | const { url, title }: StreamData = streamData 47 | 48 | let outputFile: string = buildOutputName( 49 | output, 50 | sanitizedUsername, 51 | format === 'mkv' ? 'mkv' : 'mp4' 52 | ) 53 | 54 | const ffmpegCommand = 55 | format === 'mp4' 56 | ? ffmpegCommandMP4(url, title, sanitizedUsername, outputFile) 57 | : ffmpegCommandMKV(url, title, sanitizedUsername, outputFile) 58 | 59 | fs.mkdirSync(path.dirname(outputFile), { recursive: true }) 60 | 61 | console.info(`\n✅ Downloading livestream ${title} to ./${outputFile}`) 62 | console.info(`\n❗ Ctrl+C to stop downloading and exit\n`) 63 | 64 | emitter.emit('start', { 65 | ...streamData, 66 | outputFile, 67 | cmdPreview: [ffmpegCommand.cmd, ...ffmpegCommand.args].join(' '), 68 | }) 69 | 70 | const ffmpegProcess = runFfmpeg({ 71 | cmd: ffmpegCommand.cmd, 72 | args: ffmpegCommand.args, 73 | }) 74 | 75 | ffmpegProcess.on('progress', (chunk: string) => { 76 | emitter.emit('progress', chunk) 77 | }) 78 | 79 | ffmpegProcess.on('exit', (code: number) => { 80 | if (code === 0) { 81 | console.info(`\n✅ Download completed successfully!`) 82 | emitter.emit('end', { outputFile, code }) 83 | } else { 84 | console.error(`\n❌ Download failed with exit code ${code}`) 85 | emitter.emit( 86 | 'error', 87 | new Error(`\❌ Download failed with exit code ${code}`) 88 | ) 89 | } 90 | }) 91 | ffmpegProcess.on('error', (error: Error) => { 92 | console.error(`\n❌ Error during download: ${error.message}`) 93 | emitter.emit('error', error) 94 | }) 95 | } catch (error) { 96 | emitter.emit( 97 | 'error', 98 | error instanceof Error ? error : new Error(String(error)) 99 | ) 100 | } 101 | return emitter 102 | } 103 | -------------------------------------------------------------------------------- /src/ffmpeg/ffmpegArgs.ts: -------------------------------------------------------------------------------- 1 | import { FfmpegCmd } from '../types/FfmpegCmd' 2 | 3 | /** 4 | * It takes a string as an argument and returns a FfmpegCmd object. 5 | * 6 | * @param {string} liveUrl - The live URL of the TikTok live stream. 7 | * @param {string} title - The title of the TikTok live stream. 8 | * @param {string} username - The username of the TikTok account. 9 | * @param {string} fileName - The name of the file to save the live stream to. 10 | * @returns {FfmpegCmd} object - The ffmpeg command to download the live stream in MP4 format. 11 | */ 12 | 13 | export const ffmpegCommandMP4 = ( 14 | liveUrl: string, 15 | title: string, 16 | username: string, 17 | fileName: string 18 | ): FfmpegCmd => { 19 | const year = new Date().getFullYear().toString() 20 | 21 | return { 22 | cmd: `ffmpeg`, 23 | args: [ 24 | /* --- Network Resilience --- */ 25 | '-reconnect', '1', 26 | '-reconnect_streamed', '1', 27 | '-reconnect_at_eof', '1', 28 | '-reconnect_delay_max', '5', 29 | '-rw_timeout', '8000000', // timeout in microseconds 30 | '-user_agent', 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3', 31 | '-probesize', '8M', 32 | 33 | /* --- Input --- */ 34 | '-use_wallclock_as_timestamps', '1', 35 | '-fflags', '+genpts', 36 | '-i', liveUrl, 37 | '-map', '0', 38 | 39 | /* --- Container and Metadata --- */ 40 | '-c', 'copy', 41 | '-map_metadata', '0', 42 | /* '-movflags', '+frag_keyframe+empty_moov+use_metadata_tags+faststart', */ 43 | '-metadata', `title=${title}`, 44 | '-metadata', `artist=${username}`, 45 | '-metadata', `date=${year}`, 46 | '-metadata', `comment=Downloaded from TikTok Live`, 47 | 48 | /* --- Output Format --- */ 49 | '-f', 'mp4', 50 | fileName, 51 | 52 | /* --- Safety & Logging --- */ 53 | '-nostdin', 54 | '-hide_banner', 55 | '-loglevel', 'info', 56 | '-stats', 57 | '-n' 58 | ], 59 | } 60 | } 61 | 62 | /** 63 | * It takes a string as an argument and returns a FfmpegCmd object. 64 | * 65 | * @param {string} liveUrl - The live URL of the TikTok live stream. 66 | * @param {string} fileName - The name of the file to save the live stream to. 67 | * @returns {FfmpegCmd} object - The ffmpeg command to download the live stream in MKV format. 68 | */ 69 | 70 | export const ffmpegCommandMKV = ( 71 | liveUrl: string, 72 | title: string, 73 | username: string, 74 | fileName: string 75 | ): FfmpegCmd => { 76 | const year = new Date().getFullYear().toString() 77 | return { 78 | cmd: `ffmpeg`, 79 | args: [ 80 | /* --- Network Resilience --- */ 81 | '-reconnect', '1', 82 | '-reconnect_streamed', '1', 83 | '-reconnect_at_eof', '1', 84 | '-reconnect_delay_max', '5', 85 | '-rw_timeout', '8000000', // timeout in microseconds 86 | '-user_agent', 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3', 87 | 88 | /* --- Input --- */ 89 | '-i', liveUrl, 90 | 91 | /* --- Flow Selection --- */ 92 | '-map', '0', 93 | 94 | /* --- Video Encoding --- */ 95 | '-c:v', 'libx265', 96 | '-preset', 'medium', 97 | '-crf', '22', 98 | '-pix_fmt', 'yuv420p', 99 | '-x265-params', 'keyint=48:min-keyint=48:scenecut=0:repeat-headers=1', 100 | 101 | /* --- Audio Encoding --- */ 102 | '-c:a', 'copy', 103 | 104 | /* --- Metadata --- */ 105 | '-metadata', `title=${title}`, 106 | '-metadata', `artist=${username}`, 107 | '-metadata', `date=${year}`, 108 | '-metadata', `comment=Downloaded from TikTok Live`, 109 | 110 | /* --- MKV Container --- */ 111 | '-f', 'matroska', 112 | fileName, 113 | 114 | /* --- Safety & Logging --- */ 115 | '-nostdin', 116 | '-hide_banner', 117 | '-loglevel', 'error', 118 | '-stats', 119 | '-n', 120 | ], 121 | } 122 | } 123 | -------------------------------------------------------------------------------- /src/tiktok/types/WebCastTikTokApiInterface.ts: -------------------------------------------------------------------------------- 1 | export interface WebCastTikTokApiResponse { 2 | data: Data | EmptyData; 3 | extra: TiktokCookieExtra; 4 | status_code: number; 5 | } 6 | 7 | export interface WebCastTikTokEmptyApiResponse { 8 | data: EmptyData; 9 | extra: TiktokCookieExtra; 10 | } 11 | 12 | export interface Data { 13 | AnchorABMap: AnchorAbMap; 14 | adjust_display_order: number; 15 | admin_ec_show_permission: AnchorAbMap; 16 | admin_user_ids: any[]; 17 | age_restricted: AgeRestricted; 18 | aigc_self_disclosure_switch: boolean; 19 | allow_preview_time: number; 20 | anchor_scheduled_time_text: string; 21 | anchor_share_text: string; 22 | anchor_tab_type: number; 23 | answering_question_content: string; 24 | app_id: number; 25 | audio_mute: number; 26 | auto_cover: number; 27 | book_end_time: number; 28 | book_time: number; 29 | business_live: number; 30 | challenge_info: string; 31 | client_version: number; 32 | comment_has_text_emoji_emote: number; 33 | comment_name_mode: number; 34 | commerce_info: CommerceInfo; 35 | common_label_list: string; 36 | content_tag: string; 37 | continuous_room_quota_config: AnchorAbMap; 38 | cover: Cover; 39 | cover_type: number; 40 | cpp_version: number; 41 | create_time: number; 42 | deco_list: any[]; 43 | deprecated10: string; 44 | deprecated11: string; 45 | deprecated12: string; 46 | deprecated13: string; 47 | deprecated14: number; 48 | deprecated15: number; 49 | deprecated16: number; 50 | deprecated17: any[]; 51 | deprecated18: number; 52 | deprecated19: string; 53 | deprecated195: boolean; 54 | deprecated2: string; 55 | deprecated20: number; 56 | deprecated21: boolean; 57 | deprecated22: number; 58 | deprecated23: string; 59 | deprecated24: number; 60 | deprecated26: string; 61 | deprecated28: string; 62 | deprecated3: AnchorAbMap; 63 | deprecated30: string; 64 | deprecated31: boolean; 65 | deprecated32: string; 66 | deprecated35: number; 67 | deprecated36: number; 68 | deprecated39: string; 69 | deprecated4: number; 70 | deprecated41: number; 71 | deprecated43: boolean; 72 | deprecated44: number; 73 | deprecated5: boolean; 74 | deprecated6: string; 75 | deprecated7: number; 76 | deprecated8: string; 77 | deprecated9: string; 78 | disable_preload_stream: boolean; 79 | disable_preview_sub_only: number; 80 | disable_screen_record: boolean; 81 | drawer_tab_position: string; 82 | drop_comment_group: number; 83 | ec_age_interval: number; 84 | ecommerce_room_tags: any[]; 85 | effect_frame_upload_demotion: number; 86 | effect_info: any[]; 87 | enable_optimize_sensitive_word: boolean; 88 | enable_server_drop: number; 89 | enable_stream_encryption: boolean; 90 | existed_commerce_goods: boolean; 91 | fansclub_msg_style: number; 92 | feed_room_label: Cover; 93 | feed_room_labels: any[]; 94 | filter_msg_rules: any[]; 95 | finish_reason: number; 96 | finish_time: number; 97 | finish_url: string; 98 | finish_url_v2: string; 99 | follow_msg_style: number; 100 | forum_extra_data: string; 101 | game_demo: number; 102 | game_tag: GameTag[]; 103 | gift_msg_style: number; 104 | gift_poll_vote_enabled: boolean; 105 | group_source: number; 106 | has_commerce_goods: boolean; 107 | has_more_history_comment: boolean; 108 | has_used_music: boolean; 109 | have_wishlist: boolean; 110 | history_comment_cursor: string; 111 | history_comment_list: any[]; 112 | hot_sentence_info: string; 113 | id: number; 114 | id_str: string; 115 | idc_region: string; 116 | indicators: any[]; 117 | interaction_question_version: number; 118 | introduction: string; 119 | is_gated_room: boolean; 120 | is_replay: boolean; 121 | is_show_user_card_switch: boolean; 122 | last_ping_time: number; 123 | layout: number; 124 | like_count: number; 125 | link_mic: LinkMic; 126 | linker_map: AnchorAbMap; 127 | linkmic_layout: number; 128 | lite_user_not_visible: boolean; 129 | lite_user_visible: boolean; 130 | live_distribution: any[]; 131 | live_id: number; 132 | live_reason: string; 133 | live_room_mode: number; 134 | live_sub_only: number; 135 | live_sub_only_month: number; 136 | live_sub_only_tier: number; 137 | live_sub_only_use_music: number; 138 | live_type_audio: boolean; 139 | live_type_linkmic: boolean; 140 | live_type_normal: boolean; 141 | live_type_sandbox: boolean; 142 | live_type_screenshot: boolean; 143 | live_type_social_live: boolean; 144 | live_type_third_party: boolean; 145 | living_room_attrs: LivingRoomAttrs; 146 | lottery_finish_time: number; 147 | max_continue_watch_mill_seconds: number; 148 | max_preview_time: number; 149 | mosaic_status: number; 150 | multi_stream_id: number; 151 | multi_stream_id_str: string; 152 | multi_stream_scene: number; 153 | multi_stream_source: number; 154 | net_mode: number; 155 | os_type: number; 156 | owner: Owner; 157 | owner_device_id: number; 158 | owner_device_id_str: string; 159 | owner_user_id: number; 160 | owner_user_id_str: string; 161 | paid_event: PaidEvent; 162 | partnership_info: PartnershipInfo; 163 | pico_live_type: number; 164 | polling_star_comment: boolean; 165 | pre_enter_time: number; 166 | preview_flow_tag: number; 167 | quota_config: AnchorAbMap; 168 | rank_comment_groups: any[]; 169 | ranklist_audience_type: number; 170 | regional_restricted: RegionalRestricted; 171 | relation_tag: string; 172 | replay: boolean; 173 | reposted: boolean; 174 | room_audit_status: number; 175 | room_auth: RoomAuth; 176 | room_create_ab_param: string; 177 | room_layout: number; 178 | room_llm_title: string; 179 | room_pcu: number; 180 | room_sticker_list: any[]; 181 | room_tabs: any[]; 182 | room_tag: number; 183 | rtc_app_id: string; 184 | scroll_config: string; 185 | search_id: number; 186 | share_msg_style: number; 187 | share_url: string; 188 | short_title: string; 189 | short_touch_items: any[]; 190 | show_star_comment_entrance: boolean; 191 | social_interaction: SocialInteraction; 192 | start_time: number; 193 | stats: Stats; 194 | status: number; 195 | sticker_list: any[]; 196 | stream_id: number; 197 | stream_id_str: string; 198 | stream_status: number; 199 | stream_url: StreamURL; 200 | stream_url_filtered_info: StreamURLFilteredInfo; 201 | sub_tag: number; 202 | support_quiz: number; 203 | title: string; 204 | top_fans: TopFan[]; 205 | use_filter: boolean; 206 | user_count: number; 207 | user_share_text: string; 208 | video_feed_tag: string; 209 | watch_early_quota_config: AnchorAbMap; 210 | webcast_comment_tcs: number; 211 | webcast_sdk_version: number; 212 | with_draw_something: boolean; 213 | with_ktv: boolean; 214 | with_linkmic: boolean; 215 | } 216 | 217 | export interface EmptyData { 218 | prompts: string 219 | } 220 | 221 | export interface AnchorAbMap { 222 | } 223 | 224 | export interface AgeRestricted { 225 | AgeInterval: number; 226 | restricted: boolean; 227 | source: number; 228 | } 229 | 230 | export interface CommerceInfo { 231 | commerce_permission: number; 232 | oec_live_enter_room_init_data: string; 233 | product_num: number; 234 | use_async_load: boolean; 235 | use_new_promotion: number; 236 | } 237 | 238 | export interface Cover { 239 | avg_color: AvgColor; 240 | height: number; 241 | image_type: number; 242 | is_animated: boolean; 243 | open_web_url: string; 244 | uri: string; 245 | url_list: string[]; 246 | width: number; 247 | } 248 | 249 | export enum AvgColor { 250 | Ebebff = "#EBEBFF", 251 | Empty = "", 252 | } 253 | 254 | export interface GameTag { 255 | bundle_id: string; 256 | full_name: string; 257 | game_category: any[]; 258 | hashtag_id: any[]; 259 | hashtag_list: any[]; 260 | id: number; 261 | is_new_game: boolean; 262 | landscape: number; 263 | package_name: string; 264 | short_name: string; 265 | show_name: string; 266 | } 267 | 268 | export interface LinkMic { 269 | audience_id_list: any[]; 270 | battle_scores: any[]; 271 | battle_settings: BattleSettings; 272 | channel_id: number; 273 | followed_count: number; 274 | linked_user_list: any[]; 275 | multi_live_enum: number; 276 | rival_anchor_id: number; 277 | show_user_list: any[]; 278 | } 279 | 280 | export interface BattleSettings { 281 | battle_id: number; 282 | channel_id: number; 283 | duration: number; 284 | finished: number; 285 | match_type: number; 286 | start_time: number; 287 | start_time_ms: number; 288 | theme: string; 289 | } 290 | 291 | export interface LivingRoomAttrs { 292 | admin_flag: number; 293 | rank: number; 294 | room_id: number; 295 | room_id_str: string; 296 | silence_flag: number; 297 | } 298 | 299 | export interface Owner { 300 | allow_find_by_contacts: boolean; 301 | allow_others_download_video: boolean; 302 | allow_others_download_when_sharing_video: boolean; 303 | allow_share_show_profile: boolean; 304 | allow_show_in_gossip: boolean; 305 | allow_show_my_action: boolean; 306 | allow_strange_comment: boolean; 307 | allow_unfollower_comment: boolean; 308 | allow_use_linkmic: boolean; 309 | avatar_large: Cover; 310 | avatar_medium: Cover; 311 | avatar_thumb: Cover; 312 | badge_image_list: any[]; 313 | badge_list: BadgeList[]; 314 | bg_img_url: string; 315 | bio_description: string; 316 | block_status: number; 317 | border_list: any[]; 318 | comment_restrict: number; 319 | commerce_webcast_config_ids: any[]; 320 | constellation: string; 321 | create_time: number; 322 | deprecated1: number; 323 | deprecated12: number; 324 | deprecated13: number; 325 | deprecated15: number; 326 | deprecated16: boolean; 327 | deprecated17: boolean; 328 | deprecated18: string; 329 | deprecated19: boolean; 330 | deprecated2: number; 331 | deprecated21: number; 332 | deprecated28: boolean; 333 | deprecated29: string; 334 | deprecated3: number; 335 | deprecated4: number; 336 | deprecated5: string; 337 | deprecated6: number; 338 | deprecated7: string; 339 | deprecated8: number; 340 | disable_ichat: number; 341 | display_id: string; 342 | enable_ichat_img: number; 343 | exp: number; 344 | fan_ticket_count: number; 345 | fans_club_info?: FansClubInfo; 346 | fold_stranger_chat: boolean; 347 | follow_info: FollowInfo; 348 | follow_status: number; 349 | ichat_restrict_type: number; 350 | id: number; 351 | id_str: string; 352 | is_anchor_marked: boolean; 353 | is_block: boolean; 354 | is_follower: boolean; 355 | is_following: boolean; 356 | is_subscribe: boolean; 357 | link_mic_stats: number; 358 | media_badge_image_list: any[]; 359 | mint_type_label: number[]; 360 | modify_time: number; 361 | need_profile_guide: boolean; 362 | new_real_time_icons: any[]; 363 | nickname: string; 364 | own_room?: OwnRoom; 365 | pay_grade: PayGrade; 366 | pay_score: number; 367 | pay_scores: number; 368 | push_comment_status: boolean; 369 | push_digg: boolean; 370 | push_follow: boolean; 371 | push_friend_action: boolean; 372 | push_ichat: boolean; 373 | push_status: boolean; 374 | push_video_post: boolean; 375 | push_video_recommend: boolean; 376 | real_time_icons: any[]; 377 | scm_label: string; 378 | sec_uid: string; 379 | secret: number; 380 | share_qrcode_uri: string; 381 | special_id: string; 382 | status: number; 383 | subscribe_info?: SubscribeInfo; 384 | ticket_count: number; 385 | top_fans: any[]; 386 | top_vip_no: number; 387 | upcoming_event_list: any[]; 388 | user_attr: UserAttr; 389 | user_role: number; 390 | verified: boolean; 391 | verified_content: string; 392 | verified_reason: string; 393 | with_car_management_permission: boolean; 394 | with_commerce_permission: boolean; 395 | with_fusion_shop_entry: boolean; 396 | } 397 | 398 | export interface BadgeList { 399 | OpenWebURL: string; 400 | combine: Combine; 401 | display: boolean; 402 | display_status: number; 403 | display_type: number; 404 | exhibition_type: number; 405 | greyed_by_client: number; 406 | is_customized: boolean; 407 | position: number; 408 | priority_type: number; 409 | privilege_log_extra: PrivilegeLogExtra; 410 | scene_type: number; 411 | } 412 | 413 | export interface Combine { 414 | background: Background; 415 | background_auto_mirrored: boolean; 416 | background_dark_mode: Background; 417 | display_type: number; 418 | font_style: FontStyle; 419 | icon: Cover; 420 | icon_auto_mirrored: boolean; 421 | multi_guest_show_style: number; 422 | padding: Padding; 423 | padding_new_font: Padding; 424 | personal_card_show_style: number; 425 | profile_card_panel: ProfileCardPanel; 426 | public_screen_show_style: number; 427 | ranklist_online_audience_show_style: number; 428 | str: string; 429 | } 430 | 431 | export interface Background { 432 | background_color_code: string; 433 | border_color_code: string; 434 | image: Cover; 435 | } 436 | 437 | export interface FontStyle { 438 | border_color: string; 439 | font_color: string; 440 | font_size: number; 441 | font_width: number; 442 | } 443 | 444 | export interface Padding { 445 | badge_width: number; 446 | horizontal_padding_rule: number; 447 | icon_bottom_padding: number; 448 | icon_top_padding: number; 449 | left_padding: number; 450 | middle_padding: number; 451 | right_padding: number; 452 | use_specific: boolean; 453 | vertical_padding_rule: number; 454 | } 455 | 456 | export interface ProfileCardPanel { 457 | badge_text_position: number; 458 | profile_content: ProfileContent; 459 | projection_config: ProjectionConfig; 460 | use_new_profile_card_style: boolean; 461 | } 462 | 463 | export interface ProfileContent { 464 | icon_list: any[]; 465 | use_content: boolean; 466 | } 467 | 468 | export interface ProjectionConfig { 469 | icon: Cover; 470 | use_projection: boolean; 471 | } 472 | 473 | export interface PrivilegeLogExtra { 474 | data_version: string; 475 | level: string; 476 | privilege_id: string; 477 | privilege_order_id: string; 478 | privilege_version: string; 479 | } 480 | 481 | export interface FansClubInfo { 482 | badge: Cover; 483 | fans_club_name: string; 484 | fans_count: number; 485 | fans_level: number; 486 | fans_score: number; 487 | is_sleeping: boolean; 488 | } 489 | 490 | export interface FollowInfo { 491 | follow_status: number; 492 | follower_count: number; 493 | following_count: number; 494 | push_status: number; 495 | } 496 | 497 | export interface OwnRoom { 498 | room_ids: number[]; 499 | room_ids_str: string[]; 500 | } 501 | 502 | export interface PayGrade { 503 | deprecated20: number; 504 | deprecated22: number; 505 | deprecated23: number; 506 | deprecated24: number; 507 | deprecated25: number; 508 | deprecated26: number; 509 | grade_banner: string; 510 | grade_describe: string; 511 | grade_icon_list: any[]; 512 | level: number; 513 | name: string; 514 | next_name: string; 515 | next_privileges: string; 516 | score: number; 517 | screen_chat_type: number; 518 | upgrade_need_consume: number; 519 | } 520 | 521 | export interface SubscribeInfo { 522 | anchor_gift_sub_auth: boolean; 523 | badge: Badge; 524 | enable_subscription: boolean; 525 | is_in_grace_period: boolean; 526 | is_sol_eligible: boolean; 527 | is_subscribe: boolean; 528 | is_subscribed_to_anchor: boolean; 529 | package_id: string; 530 | qualification: boolean; 531 | sol_room_display_text: string; 532 | status: number; 533 | sub_end_time: number; 534 | subscriber_count: number; 535 | timer_detail: TimerDetail; 536 | user_gift_sub_auth: boolean; 537 | } 538 | 539 | export interface Badge { 540 | is_customized: boolean; 541 | } 542 | 543 | export interface TimerDetail { 544 | anchor_id: number; 545 | anchor_side_title: string; 546 | antidirt_status: number; 547 | audit_status: number; 548 | last_pause_timestamp_s: number; 549 | remaining_time_s: number; 550 | screen_h: number; 551 | screen_w: number; 552 | start_countdown_time_s: number; 553 | start_timestamp_s: number; 554 | sticker_x: number; 555 | sticker_y: number; 556 | sub_count: number; 557 | time_increase_cap_s: number; 558 | time_increase_per_sub_s: number; 559 | time_increase_reach_cap: boolean; 560 | timer_id: number; 561 | timer_status: number; 562 | timestamp_s: number; 563 | total_pause_time_s: number; 564 | total_time_s: number; 565 | user_side_title: string; 566 | } 567 | 568 | export interface UserAttr { 569 | admin_permissions: AnchorAbMap; 570 | has_voting_function: boolean; 571 | is_admin: boolean; 572 | is_channel_admin: boolean; 573 | is_muted: boolean; 574 | is_super_admin: boolean; 575 | mute_duration: number; 576 | } 577 | 578 | export interface PaidEvent { 579 | event_id: number; 580 | paid_type: number; 581 | } 582 | 583 | export interface PartnershipInfo { 584 | partnership_room: boolean; 585 | promoting_drops_id: string; 586 | promoting_game_id: string; 587 | promoting_room: boolean; 588 | promoting_task_id: string; 589 | promoting_task_type: number; 590 | show_task_id: string; 591 | show_task_type: number; 592 | task_id_list: any[]; 593 | } 594 | 595 | export interface RegionalRestricted { 596 | block_list: any[]; 597 | } 598 | 599 | export interface RoomAuth { 600 | Banner: number; 601 | BroadcastMessage: number; 602 | Chat: boolean; 603 | ChatL2: boolean; 604 | ChatSubOnly: boolean; 605 | CommercePermission: number; 606 | CommunityFlagged: boolean; 607 | CommunityFlaggedReview: boolean; 608 | CustomizableGiftPoll: number; 609 | CustomizablePoll: number; 610 | Danmaku: boolean; 611 | Digg: boolean; 612 | DonationSticker: number; 613 | EmotePoll: number; 614 | EnableFansLevel: boolean; 615 | EnableShowUserUV: boolean; 616 | EventPromotion: number; 617 | Explore: boolean; 618 | GameRankingSwitch: number; 619 | Gift: boolean; 620 | GiftAnchorMt: number; 621 | GiftPoll: number; 622 | GoldenEnvelope: number; 623 | GoldenEnvelopeActivity: number; 624 | InteractionQuestion: boolean; 625 | Landscape: number; 626 | LandscapeChat: number; 627 | LuckMoney: boolean; 628 | MultiEnableReserve: boolean; 629 | Pictionary: number; 630 | PictionaryBubble: number; 631 | PictionaryPermission: number; 632 | Poll: number; 633 | Promote: boolean; 634 | PromoteOther: number; 635 | Props: boolean; 636 | PublicScreen: number; 637 | QuickChat: number; 638 | Rank: number; 639 | RankingChangeAlterSwitch: number; 640 | RoomContributor: boolean; 641 | SecretRoom: number; 642 | Share: boolean; 643 | ShareEffect: number; 644 | ShoppingRanking: number; 645 | SpamComments: boolean; 646 | UserCard: boolean; 647 | UserCount: number; 648 | Viewers: boolean; 649 | comment_tray_status: number; 650 | credit_entrance_for_audience: boolean; 651 | deprecated1: boolean; 652 | deprecated118: any[]; 653 | deprecated119: number; 654 | deprecated2: number; 655 | deprecated3: number; 656 | deprecated4: number; 657 | deprecated5: number; 658 | deprecated6: number; 659 | deprecated7: number; 660 | deprecated8: number; 661 | deprecated9: number; 662 | game_guess_permission: boolean; 663 | guess_entrance_for_host: boolean; 664 | show_credit_widget: boolean; 665 | transaction_history: number; 666 | use_user_pv: boolean; 667 | } 668 | 669 | export interface SocialInteraction { 670 | linkmic_scene_linker: AnchorAbMap; 671 | multi_live: MultiLive; 672 | } 673 | 674 | export interface MultiLive { 675 | audience_send_gifts_to_all_enum: number; 676 | audience_shared_invitee_panel_type: number; 677 | host_gifter_linkmic_enum: number; 678 | host_multi_guest_dev_mode: number; 679 | host_send_gifts_to_all_enum: number; 680 | linkmic_service_version: number; 681 | try_open_multi_guest_when_create_room: boolean; 682 | user_settings: UserSettings; 683 | viewer_gifter_linkmic_enum: number; 684 | } 685 | 686 | export interface UserSettings { 687 | applier_sort_gift_score_threshold: number; 688 | applier_sort_setting: number; 689 | multi_guest_allow_request_from_followers: number; 690 | multi_guest_allow_request_from_friends: number; 691 | multi_guest_allow_request_from_others: number; 692 | multi_live_apply_permission: number; 693 | } 694 | 695 | export interface Stats { 696 | deprecated1: number; 697 | deprecated2: string; 698 | digg_count: number; 699 | enter_count: number; 700 | fan_ticket: number; 701 | follow_count: number; 702 | gift_uv_count: number; 703 | id: number; 704 | id_str: string; 705 | like_count: number; 706 | replay_fan_ticket: number; 707 | replay_viewers: number; 708 | share_count: number; 709 | total_user: number; 710 | total_user_desp: string; 711 | watermelon: number; 712 | } 713 | 714 | export interface StreamURL { 715 | alive_timestamp: number; 716 | candidate_resolution: string[]; 717 | complete_push_urls: any[]; 718 | default_resolution: string; 719 | drm_type: number; 720 | extra: StreamURLExtra; 721 | flv_pull_url: FlvPullURL; 722 | flv_pull_url_params: FlvPullURL; 723 | hls_pull_url: string; 724 | hls_pull_url_map: AnchorAbMap; 725 | hls_pull_url_params: string; 726 | id: number; 727 | id_str: string; 728 | live_core_sdk_data: LiveCoreSDKData; 729 | provider: number; 730 | push_resolution: string; 731 | push_urls: any[]; 732 | resolution_name: ResolutionName; 733 | rtmp_pull_url: string; 734 | rtmp_pull_url_params: string; 735 | rtmp_push_url: string; 736 | rtmp_push_url_params: string; 737 | stream_app_id: number; 738 | stream_control_type: number; 739 | stream_delay_ms: number; 740 | stream_size_height: number; 741 | stream_size_width: number; 742 | vr_type: number; 743 | } 744 | 745 | export interface StreamURLExtra { 746 | anchor_interact_profile: number; 747 | audience_interact_profile: number; 748 | bframe_enable: boolean; 749 | bitrate_adapt_strategy: number; 750 | bytevc1_enable: boolean; 751 | default_bitrate: number; 752 | deprecated1: boolean; 753 | fps: number; 754 | gop_sec: number; 755 | hardware_encode: boolean; 756 | height: number; 757 | max_bitrate: number; 758 | min_bitrate: number; 759 | roi: boolean; 760 | sw_roi: boolean; 761 | video_profile: number; 762 | width: number; 763 | } 764 | 765 | export interface FlvPullURL { 766 | FULL_HD1: string; 767 | HD1: string; 768 | SD1: string; 769 | SD2: string; 770 | } 771 | 772 | export interface LiveCoreSDKData { 773 | pull_data: PullData; 774 | } 775 | 776 | export interface PullData { 777 | options: Options; 778 | stream_data: string; 779 | } 780 | 781 | export interface Options { 782 | default_quality: Quality; 783 | qualities: Quality[]; 784 | show_quality_button: boolean; 785 | } 786 | 787 | export interface Quality { 788 | icon_type: number; 789 | level: number; 790 | name: string; 791 | resolution: string; 792 | sdk_key: string; 793 | v_codec: string; 794 | } 795 | 796 | export interface ResolutionName { 797 | AUTO: string; 798 | FULL_HD1: string; 799 | HD1: string; 800 | ORIGION: string; 801 | SD1: string; 802 | SD2: string; 803 | pm_mt_video_1080p60: string; 804 | pm_mt_video_720p60: string; 805 | } 806 | 807 | export interface StreamURLFilteredInfo { 808 | is_gated_room: boolean; 809 | is_paid_event: boolean; 810 | } 811 | 812 | export interface TopFan { 813 | fan_ticket: number; 814 | user: Owner; 815 | } 816 | 817 | export interface TiktokCookieExtra { 818 | now: number; 819 | } 820 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------