Create a new PPM file parser instance
an ArrayBuffer containing file data
parser settings (none currently implemented)
Custom object tag
Animation frame aspect ratio, reflects PpmParser.aspect
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
Which audio tracks are available in this format, reflects PpmParser.audioTracks
In-app animation playback speed when the BGM track was recorded
Animation framerate when the BGM track was recorded, measured as frames per second
Animation duration, in seconds
File format type, reflects PpmParser.format
Animation frame count
In-app animation playback speed
Animation framerate, measured as frames per second
Global animation frame color palette, reflects PpmParser.globalPalette
Animation frame height, reflects PpmParser.height
X offset for the top-left corner of the animation frame
Y offset for the top-left corner of the animation frame
Animation frame width, reflects PpmParser.width
(KWZ only) Indicates whether or not this file is a handwritten comment from Flipnote Gallery World
(KWZ only) Indicates whether or not this Flipnote is a PPM to KWZ conversion from Flipnote Studio 3D's DSi Library service
(KWZ only) Indicates whether or not this file is a Flipnote Studio 3D folder icon
Spinoffs are remixes of another user's Flipnote
File metadata, see PpmMeta for structure
Number of colors per layer (aside from transparent), reflects PpmParser.numLayerColors
Number of animation frame layers, reflects PpmParser.numLayers
Flipnote palette
key used for Flipnote verification, in PEM format
Audio track base sample rate, reflects PpmParser.rawSampleRate
Audio output sample rate, reflects PpmParser.sampleRate
Which sound effect tracks are available in this format, reflects PpmParser.soundEffectTracks
File audio track info, see FlipnoteAudioTrackInfo
Index of the animation frame used as the Flipnote's thumbnail image
File format version; always the same as far as we know
Animation frame aspect ratio
Which audio tracks are available in this format
Default PPM parser settings
File format type
Global animation frame color palette
Animation frame height
Number of colors per layer (aside from transparent)
Number of animation frame layers
Public key used for Flipnote verification, in PEM format
Audio track base sample rate
Nintendo DSi audio output rate
Which sound effect tracks are available in this format
Animation frame width
Get the decoded audio data for a given track, using the track's native samplerate
Signed 16-bit PCM audio
Get the sound effect flags for every frame in the Flipnote
Get the full mixed audio for the Flipnote, using the specified samplerate
Signed 16-bit PCM audio
Get the decoded audio data for a given track, using the specified samplerate
Signed 16-bit PCM audio
Get the raw compressed audio data for a given track
byte array
Get the sound effect usage flags for a given frame
Get the sound effect usage flags for every frame
Get the usage flags for a given track across every frame
an array of booleans for every frame, indicating whether the track is used on that frame
Does an audio track exist in the Flipnote?
boolean
Is a given track used on a given frame
Decode a frame, returning the raw pixel buffers for each layer
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.
Array of booleans, indicating whether each layer uses a photo or not
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.
Get the layer draw order for a given frame
Array of layer indices, in the order they should be drawn
Get the RGBA colors for a given frame
Returns an array where:
Get the color palette indices for a given frame. RGBA colors for these values can be indexed from PpmParser.globalPalette
Returns an array where:
Get the color palette for a given frame, as an uint32 array
Get the image for a given frame, as palette indices
Get the image for a given frame as an uint32 array of RGBA pixels
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.
Get the pixels for a given frame layer, as palette indices NOTE: layerIndex are not guaranteed to be sorted by 3D depth in KWZs, use getFrameLayerOrder to get the correct sort order first NOTE: if the visibility flag for this layer is turned off, the result will be empty
Get the pixels for a given frame layer, as RGBA pixels NOTE: layerIndex are not guaranteed to be sorted by 3D depth in KWZs, use getFrameLayerOrder to get the correct sort order first NOTE: if the visibility flag for this layer is turned off, the result will be empty
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.
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.
Allows for frame index iteration when using the parser instance as a for..of iterator
for (const frameIndex of note) {
// do something with frameIndex...
}
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'
}
Returns the Flipnote title when casting a parser instance to a string
const str = 'Title: ' + note;
// str === 'Title: Flipnote by username'
Get the body of the Flipnote - the data that is digested for the signature
Get the Flipnote's signature data
Verify whether this Flipnote's signature is valid
Animation frame global layer visibility
Default formats used for {@link getTitle()}
Parser class for (DSiWare) Flipnote Studio's PPM animation format.
Format docs: https://github.com/Flipnote-Collective/flipnote-studio-docs/wiki/PPM-format