m3u8-conver-core v1.2.0

📖Introduction

Convert network or local m3u8 files to media files (such as mp4, avi, etc.)

🚀Install

Make sure Nodejs>=v16.0.0

If you do not install Nodejs, Please install Nodejs

# npm
npm install m3u8-conver-core

# pnpm
pnpm install m3u8-conver-core

🚗Use

custom parser see ✏️Advanced

import mconver from "../index.js"
const options = {
    url: "https://www.test.com",
    // input: "1.m3u8",
}

const output = await mconver(options)
// or callbacks
await mconver(options, {
  parsered(fragments) {
      console.log("parsered")
  },
  downloadChange(total, current, fragment) {
      console.log(`downloading... [${current + 1}/${total}]\r`)
  },
  ...
})
console.log("convered path: ", output)

🔧Options

options

• urlString: indicates the url of the m3u8 file to be converted
• inputString: indicates the local m3u8 file to be converted
• pathString: save path after conversion. Default: save path of the current terminal
• nameString: indicates the converted file name (including the suffix). The default value is "execute timestamp.mp4".
• tempDirString: indicates the temporary save path for ts chips. Default value: path.resolve(__dirname, '.temp'),
• encodeSuffixString: indicates the suffix of an undecrypted ts slice. The default is ".encode".
• decodeSuffixString: decrypted or undecrypted ts slice suffix. Default: ".ts"
• clearBoolean: Specifies whether to execute only the clear cache
• httpOptionshttpOptions: http option to download ts slice, default: {}. The following are common configurations. See more detailsgot-options.Note: This configuration only takes effect when you download ts files, not when you download keys. Use a custom parser if necessary.
  • methodString: Request method, default: "GET"
  • headersObject: Request header information
  • timeoutObject: Configure the request timeout. See detailsgot-timeout
  • bodyString|Buffer|Stream|Generator|AsyncGenerator|FormData|undefined: The request body is generally used with headers"Content-Type"

callbacks

• parsered(fragments)

  • fragmentsArray: indicates information about all fragments after resolution

• downloadChange(total, current, fragment)

  • totalNumber: indicates the total number
  • currentNumber: indicates the current index
  • fragmentObject: indicates information about the current ts fragment

• parserHandler(fragment, index)

  • fragmentObject: indicates information about the current ts fragment
  • indexNumber: indicates the current index

✏️Advanced

Custom parser

In the vast majority of cases, you only need to use the standard m3u8 parser we provide without knowing its internal implementation.

In order to provide a more flexible way to use, we provide custom parsers to meet different needs.

Parser parameters

The parser must be a function whose 'this' points to an instance of Origin, and if you use an arrow function, then you won't be able to access its internal properties (if you don't need them, you can ignore them). It takes two arguments' fragment 'and' index '(the index of the currently executed fragment).

fragment

• fragmentObject: indicates all parsed ts fragments

  • durationNumber: indicates the duration of the segment
  • uriString: uri link of the fragment
  • keyObject: indicates an encryption parameter. If no, it indicates that no encryption is performed
    • key.methodString: indicates the encryption method
    • key.uriString: uri link of the encrypted key
    • key.ivArrayBuffer: indicates the encrypted iv
    • key.keyArrayBuffer: indicates the encrypted key content. The value is obtained by the uri
  • encryptionBoolean: Specifies whether the segment is encrypted. The default value is false
  • timelineNumber: Timeline

• indexNumber: indicates the index of the current ts segment

Parser return value

The parser must return a 'fragment' object, and if there is an encryption argument (' fragment.key '), it must ensure its correctness.

Because when you use a custom parser, our parser will not execute, and the returned fragment will be used as the basis for subsequent decryption and download of m3u8. If the encryption parameter of 'fragment' returned is incorrect, the m3u8 file cannot be successfully converted. If there is no encryption parameter, ignore it.

Example

The following example is a partial implementation of our parser, which you can use as a reference to implement your own parser.

async function parserHandler(fragment, index) {
    // fragment ts uri has portcol?
    // if not, use resolve merge `options.url`(m3u8 file url)
    fragment.uri = fragment.uri.startsWith("http")
        ? fragment.uri
        : url.resolve(this.options.url/* options.url  */, fragment.uri)

    // if fragment not key, this not's encryption
    // No parsing required
    const key = Object.assign({}, fragment.key)
    if (!key || Object.keys(key).length === 0) {
        return fragment
    }

    // Next all encryption is true
    fragment.encryption = true
    // The standard encryption method is `AES-128-CBD`
    key.method = (key.method + "-cbc").toUpperCase()
    // ts key uri has portcol?
    key.uri = key.uri.startsWith("http") ? key.uri : url.resolve(fragment.uri, key.uri)
    // get key data(key.key) by key.uri
    // If you have a key cache
    // use it directly to avoid repeated acquisition and unnecessary network time
    if (this.keyCache[key.uri]) {
        key.key = this.keyCache[key.uri]
    } else {
        const keyResponse = await got(key.uri, { responseType: "buffer" })
        key.key = keyResponse.body.buffer
        this.keyCache[key.uri] = key.key
    }

    // Reset the parsed key information
    fragment.key = key

    // Return fragment. This is a must
    return fragment
}

TODOS

• decode AES-196-CBC/AES-196-CBC
• Custom Http Header downloads
• multithreading downloading