PpmParser

Defined in: src/parsers/PpmParser.ts:115

Parser class for (DSiWare) Flipnote Studio’s PPM animation format. Format docs: https://github.com/Flipnote-Collective/flipnote-studio-docs/wiki/PPM-format

Extends

• BaseParser

Constructors

new PpmParser()

new PpmParser(arrayBuffer, settings): PpmParser

Defined in: src/parsers/PpmParser.ts:298

Create a new PPM file parser instance

Parameters

Parameter	Type	Description
arrayBuffer	ArrayBufferLike	an ArrayBuffer containing file data
settings	Partial<PpmParserSettings>	parser settings (none currently implemented)

Returns

PpmParser

Overrides

BaseParser.constructor

Accessors

bytes

Get Signature

get bytes(): Uint8Array

Defined in: src/utils/DataStream.ts:41

Returns the data as an Uint8Array of bytes.

Returns

Uint8Array

Inherited from

BaseParser.bytes

---

numBytes

Get Signature

get numBytes(): number

Defined in: src/utils/DataStream.ts:48

Returns the total number of bytes in the data.

Returns

number

Inherited from

BaseParser.numBytes

Properties

defaultSettings

static defaultSettings: PpmParserSettings = {}

Defined in: src/parsers/PpmParser.ts:120

Default PPM parser settings.

---

format

static format: FlipnoteFormat = FlipnoteFormat.PPM

Defined in: src/parsers/PpmParser.ts:124

File format type.

Overrides

BaseParser.format

---

width

static width: number = 256

Defined in: src/parsers/PpmParser.ts:128

Animation frame width.

Overrides

BaseParser.width

---

height

static height: number = 192

Defined in: src/parsers/PpmParser.ts:132

Animation frame height.

Overrides

BaseParser.height

---

aspect

static aspect: number

Defined in: src/parsers/PpmParser.ts:136

Animation frame aspect ratio.

Overrides

BaseParser.aspect

---

numLayers

static numLayers: number = 2

Defined in: src/parsers/PpmParser.ts:140

Number of animation frame layers.

Overrides

BaseParser.numLayers

---

numLayerColors

static numLayerColors: number = 1

Defined in: src/parsers/PpmParser.ts:144

Number of colors per layer (aside from transparent).

Overrides

BaseParser.numLayerColors

---

rawSampleRate

static rawSampleRate: number = 8192

Defined in: src/parsers/PpmParser.ts:148

Audio track base sample rate.

Overrides

BaseParser.rawSampleRate

---

sampleRate

static sampleRate: number = 32768

Defined in: src/parsers/PpmParser.ts:152

Nintendo DSi audio output rate.

Overrides

BaseParser.sampleRate

---

audioTracks

static audioTracks: FlipnoteAudioTrack[]

Defined in: src/parsers/PpmParser.ts:156

Which audio tracks are available in this format.

Overrides

BaseParser.audioTracks

---

soundEffectTracks

static soundEffectTracks: FlipnoteSoundEffectTrack[]

Defined in: src/parsers/PpmParser.ts:165

Which sound effect tracks are available in this format.

Overrides

BaseParser.soundEffectTracks

---

globalPalette

static globalPalette: FlipnotePaletteColor[]

Defined in: src/parsers/PpmParser.ts:173

Global animation frame color palette.

Overrides

BaseParser.globalPalette

---

publicKey

static publicKey: string = PPM_PUBLIC_KEY

Defined in: src/parsers/PpmParser.ts:182

Public key used for Flipnote verification, in PEM format.

Overrides

BaseParser.publicKey

Methods

matchBuffer()

static matchBuffer(buffer): boolean

Defined in: src/parsers/PpmParser.ts:184

Parameters

Parameter	Type
buffer	ArrayBufferLike

Returns

boolean

---

end()

end(): boolean

Defined in: src/utils/DataStream.ts:253

Returns

boolean

Inherited from

BaseParser.end

Meta

titleFormats

titleFormats: object

Defined in: src/parsers/BaseParser.ts:111

Default formats used for getTitle.

Name	Type	Default value
COMMENT	string	’Comment by $USERNAME’
FLIPNOTE	string	’Flipnote by $USERNAME’
ICON	string	’Folder icon’

Inherited from

BaseParser.titleFormats

---

soundMeta

soundMeta: Map<FlipnoteAudioTrack, FlipnoteAudioTrackInfo>

Defined in: src/parsers/BaseParser.ts:194

File audio track info, see FlipnoteAudioTrackInfo.

Inherited from

BaseParser.soundMeta

---

isSpinoff

isSpinoff: boolean

Defined in: src/parsers/BaseParser.ts:210

Spinoffs are remixes of another user’s Flipnote.

Inherited from

BaseParser.isSpinoff

---

isFolderIcon

isFolderIcon: boolean = false

Defined in: src/parsers/BaseParser.ts:215

(KWZ only) Indicates whether or not this file is a Flipnote Studio 3D folder icon.

Inherited from

BaseParser.isFolderIcon

---

isComment

isComment: boolean = false

Defined in: src/parsers/BaseParser.ts:220

(KWZ only) Indicates whether or not this file is a handwritten comment from Flipnote Gallery World.

Inherited from

BaseParser.isComment

---

isDsiLibraryNote

isDsiLibraryNote: boolean = false

Defined in: src/parsers/BaseParser.ts:225

(KWZ only) Indicates whether or not this Flipnote is a PPM to KWZ conversion from Flipnote Studio 3D’s DSi Library service.

Inherited from

BaseParser.isDsiLibraryNote

---

format

format: FlipnoteFormat = FlipnoteFormat.PPM

Defined in: src/parsers/PpmParser.ts:196

File format type, reflects PpmParser.format.

Overrides

BaseParser.format

---

meta

meta: PpmMeta

Defined in: src/parsers/PpmParser.ts:276

File metadata, see PpmMeta for structure.

Overrides

BaseParser.meta

---

version

version: number

Defined in: src/parsers/PpmParser.ts:281

File format version; always the same as far as we know.

---

getTitle()

getTitle(formats): string

Defined in: src/parsers/BaseParser.ts:279

Get file default title - e.g. “Flipnote by Y”, “Comment by X”, etc. A format object can be passed for localization, where $USERNAME gets replaced by author name:

{
 COMMENT: 'Comment by $USERNAME',
 FLIPNOTE: 'Flipnote by $USERNAME',
 ICON: 'Folder icon'
}

Parameters

Parameter	Type
formats	{ COMMENT: string; FLIPNOTE: string; ICON: string; }
formats.COMMENT	string
formats.FLIPNOTE	string
formats.ICON	string

Returns

string

Inherited from

BaseParser.getTitle

---

getThumbnailImage()

getThumbnailImage(): object

Defined in: src/parsers/PpmParser.ts:459

Decodes the thumbnail image embedded in the Flipnote. Will return a FlipnoteThumbImage containing raw RGBA data.

Note: For most purposes, you should probably just decode the thumbnail frame to get a higher resolution image.

Returns

object

format

format: FlipnoteThumbImageFormat = FlipnoteThumbImageFormat.Rgba

width

width: number = 64

height

height: number = 48

data

data: ArrayBufferLike = pixels.buffer

Overrides

BaseParser.getThumbnailImage

---

getMemoryMeterLevel()

getMemoryMeterLevel(): number

Defined in: src/parsers/PpmParser.ts:492

Get the memory meter level for the Flipnote. This is a value between 0 and 1 indicating how “full” the Flipnote is, based on the size limit of Flipnote Studio.

Values will never be below 0, but can be above 1 if the Flipnote is larger than the size limit - it is technically possible to exceed the size limit by one frame.

Returns

number

Overrides

BaseParser.getMemoryMeterLevel

---

getFrameAuthor()

getFrameAuthor(frameIndex): string

Defined in: src/parsers/PpmParser.ts:723

Get the FSID for a given frame’s original author. The PPM format doesn’t actually store this information, so the current author FSID is returned. This method is only here for consistency with KWZ.

Parameters

Parameter	Type	Description
frameIndex	number

Returns

string

Overrides

BaseParser.getFrameAuthor

Image

palette

palette: FlipnotePaletteDefinition

Defined in: src/parsers/BaseParser.ts:184

Flipnote palette.

Inherited from

BaseParser.palette

---

layerVisibility

layerVisibility: FlipnoteLayerVisibility

Defined in: src/parsers/BaseParser.ts:199

Animation frame global layer visibility.

Inherited from

BaseParser.layerVisibility

---

frameCount

frameCount: number

Defined in: src/parsers/BaseParser.ts:230

Animation frame count.

Inherited from

BaseParser.frameCount

---

frameSpeed

frameSpeed: number

Defined in: src/parsers/BaseParser.ts:235

In-app animation playback speed.

Inherited from

BaseParser.frameSpeed

---

duration

duration: number

Defined in: src/parsers/BaseParser.ts:240

Animation duration, in seconds.

Inherited from

BaseParser.duration

---

bgmSpeed

bgmSpeed: number

Defined in: src/parsers/BaseParser.ts:245

In-app animation playback speed when the BGM track was recorded.

Inherited from

BaseParser.bgmSpeed

---

framerate

framerate: number

Defined in: src/parsers/BaseParser.ts:250

Animation framerate, measured as frames per second.

Inherited from

BaseParser.framerate

---

thumbFrameIndex

thumbFrameIndex: number

Defined in: src/parsers/BaseParser.ts:260

Index of the animation frame used as the Flipnote’s thumbnail image.

Inherited from

BaseParser.thumbFrameIndex

---

imageWidth

imageWidth: number = PpmParser.width

Defined in: src/parsers/PpmParser.ts:206

Animation frame width, reflects PpmParser.width.

Overrides

BaseParser.imageWidth

---

imageHeight

imageHeight: number = PpmParser.height

Defined in: src/parsers/PpmParser.ts:211

Animation frame height, reflects PpmParser.height.

Overrides

BaseParser.imageHeight

---

aspect

aspect: number = PpmParser.aspect

Defined in: src/parsers/PpmParser.ts:216

Animation frame aspect ratio, reflects PpmParser.aspect.

Overrides

BaseParser.aspect

---

imageOffsetX

imageOffsetX: number = 0

Defined in: src/parsers/PpmParser.ts:221

X offset for the top-left corner of the animation frame.

Overrides

BaseParser.imageOffsetX

---

imageOffsetY

imageOffsetY: number = 0

Defined in: src/parsers/PpmParser.ts:226

Y offset for the top-left corner of the animation frame.

Overrides

BaseParser.imageOffsetY

---

numLayers

numLayers: number = PpmParser.numLayers

Defined in: src/parsers/PpmParser.ts:231

Number of animation frame layers, reflects PpmParser.numLayers.

Overrides

BaseParser.numLayers

---

numLayerColors

numLayerColors: number = PpmParser.numLayerColors

Defined in: src/parsers/PpmParser.ts:236

Number of colors per layer (aside from transparent), reflects PpmParser.numLayerColors.

Overrides

BaseParser.numLayerColors

---

globalPalette

globalPalette: FlipnotePaletteColor[] = PpmParser.globalPalette

Defined in: src/parsers/PpmParser.ts:271

Global animation frame color palette, reflects PpmParser.globalPalette.

Overrides

BaseParser.globalPalette

---

getLayerPixels()

getLayerPixels(frameIndex, layerIndex, imageBuffer, depthStrength, depthEye): Uint8Array

Defined in: src/parsers/BaseParser.ts:351

Get the pixels for a given frame layer, as palette indices

Tip

Layer indices are not guaranteed to be sorted by 3D depth in KWZs, use getFrameLayerOrder to get the correct sort order first.

Tip

If the visibility flag for this layer is turned off, the result will be empty

Parameters

Parameter	Type	Default value
frameIndex	number	undefined
layerIndex	number	undefined
imageBuffer	Uint8Array	...
depthStrength	number	0
depthEye	FlipnoteStereoscopicEye	FlipnoteStereoscopicEye.Left

Returns

Uint8Array

Inherited from

BaseParser.getLayerPixels

---

getLayerPixelsRgba()

getLayerPixelsRgba(frameIndex, layerIndex, imageBuffer, paletteBuffer, depthStrength, depthEye): Uint32Array

Defined in: src/parsers/BaseParser.ts:406

Get the pixels for a given frame layer, as RGBA pixels

Tip

Layer indices are not guaranteed to be sorted by 3D depth in KWZs, use getFrameLayerOrder to get the correct sort order first.

Tip

If the visibility flag for this layer is turned off, the result will be empty

Parameters

Parameter	Type	Default value
frameIndex	number	undefined
layerIndex	number	undefined
imageBuffer	Uint32Array	...
paletteBuffer	Uint32Array	...
depthStrength	number	0
depthEye	FlipnoteStereoscopicEye	FlipnoteStereoscopicEye.Left

Returns

Uint32Array

Inherited from

BaseParser.getLayerPixelsRgba

---

getFramePixels()

getFramePixels(frameIndex, imageBuffer, depthStrength, depthEye): Uint8Array

Defined in: src/parsers/BaseParser.ts:488

Get the image for a given frame, as palette indices

Parameters

Parameter	Type	Default value
frameIndex	number	undefined
imageBuffer	Uint8Array	...
depthStrength	number	0
depthEye	FlipnoteStereoscopicEye	FlipnoteStereoscopicEye.Left

Returns

Uint8Array

Inherited from

BaseParser.getFramePixels

---

getFramePixelsRgba()

getFramePixelsRgba(frameIndex, imageBuffer, paletteBuffer, depthStrength, depthEye): Uint32Array

Defined in: src/parsers/BaseParser.ts:538

Get the image for a given frame as an uint32 array of RGBA pixels

Parameters

Parameter	Type	Default value
frameIndex	number	undefined
imageBuffer	Uint32Array	...
paletteBuffer	Uint32Array	...
depthStrength	number	0
depthEye	FlipnoteStereoscopicEye	FlipnoteStereoscopicEye.Left

Returns

Uint32Array

Inherited from

BaseParser.getFramePixelsRgba

---

getFramePaletteUint32()

getFramePaletteUint32(frameIndex, paletteBuffer): Uint32Array

Defined in: src/parsers/BaseParser.ts:603

Get the color palette for a given frame, as an uint32 array

Parameters

Parameter	Type
frameIndex	number
paletteBuffer	Uint32Array

Returns

Uint32Array

Inherited from

BaseParser.getFramePaletteUint32

---

decodeFrame()

decodeFrame(frameIndex): [Uint8Array, Uint8Array]

Defined in: src/parsers/PpmParser.ts:504

Decode a frame, returning the raw pixel buffers for each layer

Parameters

Parameter	Type
frameIndex	number

Returns

[Uint8Array, Uint8Array]

Overrides

BaseParser.decodeFrame

---

getFramePaletteIndices()

getFramePaletteIndices(frameIndex): number[]

Defined in: src/parsers/PpmParser.ts:666

Get the color palette indices for a given frame. RGBA colors for these values can be indexed from PpmParser.globalPalette

Returns an array where:

• index 0 is the paper color index
• index 1 is the layer 1 color index
• index 2 is the layer 2 color index

Parameters

Parameter	Type
frameIndex	number

Returns

number[]

Overrides

BaseParser.getFramePaletteIndices

---

getFramePalette()

getFramePalette(frameIndex): FlipnotePaletteColor[]

Defined in: src/parsers/PpmParser.ts:693

Get the RGBA colors for a given frame

Returns an array where:

• index 0 is the paper color
• index 1 is the layer 1 color
• index 2 is the layer 2 color

Parameters

Parameter	Type
frameIndex	number

Returns

FlipnotePaletteColor[]

Overrides

BaseParser.getFramePalette

---

getIsKeyFrame()

getIsKeyFrame(frameIndex): boolean[]

Defined in: src/parsers/PpmParser.ts:704

Determines if a given frame is a video key frame or not. This returns an array of booleans for each layer, since in the KWZ format, keyframe encoding is done on a per-layer basis.

Parameters

Parameter	Type	Description
frameIndex	number

Returns

boolean[]

Overrides

BaseParser.getIsKeyFrame

---

getFrameLayerDepths()

getFrameLayerDepths(frameIndex): number[]

Defined in: src/parsers/PpmParser.ts:714

Get the 3D depths for each layer in a given frame. The PPM format doesn’t actually store this information, so 0 is returned for both layers. This method is only here for consistency with KWZ.

Parameters

Parameter	Type	Description
frameIndex	number

Returns

number[]

Overrides

BaseParser.getFrameLayerDepths

---

getFrameCameraFlags()

getFrameCameraFlags(frameIndex): boolean[]

Defined in: src/parsers/PpmParser.ts:732

Get the camera flags for a given frame. The PPM format doesn’t actually store this information so false will be returned for both layers. This method is only here for consistency with KWZ.

Parameters

Parameter	Type
frameIndex	number

Returns

boolean[]

Array of booleans, indicating whether each layer uses a photo or not

Overrides

BaseParser.getFrameCameraFlags

---

getFrameLayerOrder()

getFrameLayerOrder(frameIndex): number[]

Defined in: src/parsers/PpmParser.ts:741

Get the layer draw order for a given frame

Parameters

Parameter	Type
frameIndex	number

Returns

number[]

Array of layer indices, in the order they should be drawn

Overrides

BaseParser.getFrameLayerOrder

Audio

bgmrate

bgmrate: number

Defined in: src/parsers/BaseParser.ts:255

Animation framerate when the BGM track was recorded, measured as frames per second.

Inherited from

BaseParser.bgmrate

---

audioClipRatio

audioClipRatio: number

Defined in: src/parsers/BaseParser.ts:265

Get the amount of clipping in the master audio track, useful for determining if a Flipnote’s audio is corrupted. Closer to 1.0 = more clipping. Only available after getAudioMasterPcm has been called.

Inherited from

BaseParser.audioClipRatio

---

audioTracks

audioTracks: FlipnoteAudioTrack[] = PpmParser.audioTracks

Defined in: src/parsers/PpmParser.ts:251

Which audio tracks are available in this format, reflects PpmParser.audioTracks.

Overrides

BaseParser.audioTracks

---

soundEffectTracks

soundEffectTracks: FlipnoteSoundEffectTrack[] = PpmParser.soundEffectTracks

Defined in: src/parsers/PpmParser.ts:256

Which sound effect tracks are available in this format, reflects PpmParser.soundEffectTracks.

Overrides

BaseParser.soundEffectTracks

---

rawSampleRate

rawSampleRate: number = PpmParser.rawSampleRate

Defined in: src/parsers/PpmParser.ts:261

Audio track base sample rate, reflects PpmParser.rawSampleRate.

Overrides

BaseParser.rawSampleRate

---

sampleRate

sampleRate: number = PpmParser.sampleRate

Defined in: src/parsers/PpmParser.ts:266

Audio output sample rate, reflects PpmParser.sampleRate.

Overrides

BaseParser.sampleRate

---

getSoundEffectFlagsForTrack()

getSoundEffectFlagsForTrack(trackId): boolean[]

Defined in: src/parsers/BaseParser.ts:637

Get the usage flags for a given track across every frame

Parameters

Parameter	Type
trackId	FlipnoteSoundEffectTrack

Returns

boolean[]

an array of booleans for every frame, indicating whether the track is used on that frame

Inherited from

BaseParser.getSoundEffectFlagsForTrack

---

isSoundEffectUsedOnFrame()

isSoundEffectUsedOnFrame(trackId, frameIndex): boolean

Defined in: src/parsers/BaseParser.ts:645

Is a given track used on a given frame

Parameters

Parameter	Type
trackId	FlipnoteSoundEffectTrack
frameIndex	number

Returns

boolean

Inherited from

BaseParser.isSoundEffectUsedOnFrame

---

hasAudioTrack()

hasAudioTrack(trackId): boolean

Defined in: src/parsers/BaseParser.ts:657

Does an audio track exist in the Flipnote?

Parameters

Parameter	Type
trackId	FlipnoteAudioTrack

Returns

boolean

boolean

Inherited from

BaseParser.hasAudioTrack

---

decodeSoundFlags()

decodeSoundFlags(): boolean[][]

Defined in: src/parsers/PpmParser.ts:749

Get the sound effect flags for every frame in the Flipnote

Returns

boolean[][]

Overrides

BaseParser.decodeSoundFlags

---

getSoundEffectFlags()

getSoundEffectFlags(): FlipnoteSoundEffectFlags[]

Defined in: src/parsers/PpmParser.ts:773

Get the sound effect usage flags for every frame

Returns

FlipnoteSoundEffectFlags[]

Overrides

BaseParser.getSoundEffectFlags

---

getFrameSoundEffectFlags()

getFrameSoundEffectFlags(frameIndex): FlipnoteSoundEffectFlags

Defined in: src/parsers/PpmParser.ts:786

Get the sound effect usage flags for a given frame

Parameters

Parameter	Type
frameIndex	number

Returns

FlipnoteSoundEffectFlags

Overrides

BaseParser.getFrameSoundEffectFlags

---

getAudioTrackRaw()

getAudioTrackRaw(trackId): Uint8Array

Defined in: src/parsers/PpmParser.ts:803

Get the raw compressed audio data for a given track

Parameters

Parameter	Type
trackId	FlipnoteAudioTrack

Returns

Uint8Array

byte array

Overrides

BaseParser.getAudioTrackRaw

---

decodeAudioTrack()

decodeAudioTrack(trackId): Int16Array

Defined in: src/parsers/PpmParser.ts:815

Get the decoded audio data for a given track, using the track’s native samplerate

Parameters

Parameter	Type
trackId	FlipnoteAudioTrack

Returns

Int16Array

Signed 16-bit PCM audio

Overrides

BaseParser.decodeAudioTrack

---

getAudioTrackPcm()

getAudioTrackPcm(trackId, dstFreq): Int16Array

Defined in: src/parsers/PpmParser.ts:860

Get the decoded audio data for a given track, using the specified samplerate

Parameters

Parameter	Type
trackId	FlipnoteAudioTrack
dstFreq	number

Returns

Int16Array

Signed 16-bit PCM audio

Overrides

BaseParser.getAudioTrackPcm

---

getAudioMasterPcm()

getAudioMasterPcm(dstFreq): Int16Array

Defined in: src/parsers/PpmParser.ts:889

Get the full mixed audio for the Flipnote, using the specified samplerate

Parameters

Parameter	Type
dstFreq	number

Returns

Int16Array

Signed 16-bit PCM audio

Overrides

BaseParser.getAudioMasterPcm

Verification

publicKey

publicKey: string = PpmParser.publicKey

Defined in: src/parsers/PpmParser.ts:241

Key used for Flipnote verification, in PEM format.

Overrides

BaseParser.publicKey

---

getBody()

getBody(): Uint8Array

Defined in: src/parsers/PpmParser.ts:927

Get the body of the Flipnote - the data that is digested for the signature

Returns

Uint8Array

Overrides

BaseParser.getBody

---

getSignature()

getSignature(): Uint8Array

Defined in: src/parsers/PpmParser.ts:936

Get the Flipnote’s signature data

Returns

Uint8Array

Overrides

BaseParser.getSignature

---

verify()

verify(): Promise<boolean>

Defined in: src/parsers/PpmParser.ts:945

Verify whether this Flipnote’s signature is valid

Returns

Promise<boolean>

Overrides

BaseParser.verify

Utility

[toStringTag]

[toStringTag]: string = 'Flipnote Studio PPM animation file'

Defined in: src/parsers/PpmParser.ts:201

Custom object tag.

Overrides

BaseParser.[toStringTag]

---

toString()

toString(): string

Defined in: src/parsers/BaseParser.ts:295

Returns the Flipnote title when casting a parser instance to a string.

const str = 'Title: ' + note;
// str === 'Title: Flipnote by username'

Returns

string

Inherited from

BaseParser.toString

---

[iterator]()

[iterator](): Generator<number, void, unknown>

Defined in: src/parsers/BaseParser.ts:309

Allows for frame index iteration when using the parser instance as a for..of iterator.

for (const frameIndex of note) {
  // do something with frameIndex...
}

Returns

Generator<number, void, unknown>

Inherited from

BaseParser.[iterator]