mediaforge - v2.2.0
    Preparing search index...

    Interface ToneMapOptions

    interface ToneMapOptions {
        algorithm?: ToneMapAlgorithm;
        peak?: number;
        targetPeak?: number;
        parameter?: number;
        desaturation?: number;
        normalizeInput?: boolean;
        input: string;
        output: string;
        outputColorSpace?: ToneMapOutput;
        videoCodec?: string;
        audioCodec?: string;
        binary?: string;
        requireHdrInput?: boolean;
    }

    Hierarchy

    Index

    Properties

    algorithm? peak? targetPeak? parameter? desaturation? normalizeInput? input output outputColorSpace? videoCodec? audioCodec? binary? requireHdrInput?

    Properties

    algorithm?: ToneMapAlgorithm

    Tone-mapping curve. Default: 'mobius' — the perceptually best of the built-ins for HDR→SDR at typical content levels.

    peak?: number

    Peak luminance of the source in nits, e.g. 1000 for a PQ 1000-nit master.

    targetPeak?: number

    Desired output peak in nits. Default: 100 (SDR reference white).

    parameter?: number

    Parametric tuning used by the mobius/reinhard/linear algorithms. Ignored by hable, clip and spline.

    desaturation?: number

    Desaturation applied to out-of-range colours, 0-1. Default: 0.6

    normalizeInput?: boolean

    Correct the source primaries/transfer before tone mapping. Default: true. Set false if the input is already tagged correctly and you only want the transfer-function curve applied.

    input: string
    output: string
    outputColorSpace?: ToneMapOutput

    Target colour space for the SDR result. Default: 'bt709'

    videoCodec?: string
    audioCodec?: string
    binary?: string
    requireHdrInput?: boolean

    Reject the job unless the input actually looks like HDR. Default: true — tone mapping an already-SDR source is almost always a mistake.

    Settings

    Member Visibility

    On This Page

    Properties