| ICompressedAudioInfo
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/AudioDecompress.h |
Include |
#include "AudioDecompress.h" |
class IStreamedCompressedInfo : public ICompressedAudioInfo
Default implementation of a streamed compressed audio format. Can be subclassed to support streaming of a specific asset format. Handles all the platform independent aspects of file format streaming for you (dealing with UE4 streamed assets)
Name | Description | ||
---|---|---|---|
|
AudioDataChunkIndex |
The chunk index where the actual audio data starts. |
|
|
AudioDataOffset |
Where the actual audio data starts in the current streamed chunk. Accounts for header offset. |
|
|
bIsStreaming |
Bool set before ParseHeader. Whether we are streaming a file or not. |
|
|
bPrintChunkFailMessage |
Whether or not to print the chunk fail message. |
|
|
bStoringEndOfFile |
If we're currently reading the final buffer. |
|
|
CurCompressedChunkHandle |
Chunk Handle to ensure that this chunk of streamed audio is not deleted while we are using it. |
|
|
CurrentChunkIndex |
The current chunk index in the streamed chunks. |
|
|
CurrentSampleCount |
How many samples we've currently read in the source file. |
|
|
LastDecodedPCM |
The decoded PCM byte array from the last decoded frame. |
|
|
LastPCMByteSize |
The amount of PCM data in bytes was decoded last. |
|
|
LastPCMOffset |
The current offset in the last decoded PCM buffer. |
|
|
MaxFrameSizeSamples |
The maximum number of samples per decode frame. |
|
|
NumChannels |
Number of channels (left/right) in the source file. |
|
|
SampleRate |
Sample rate of the source file |
|
|
SampleStride |
The number of bytes per interleaved sample (NumChannels * sizeof(int16)). |
|
|
const uint8 ... |
SrcBufferData |
Ptr to the current streamed chunk. |
|
SrcBufferDataSize |
Size of the current streamed chunk. |
|
|
SrcBufferOffset |
What byte we're currently reading in the streamed chunk. |
|
|
SrcBufferPadding |
Number of bytes of padding used, overridden in some implementations. Defaults to 0. |
|
|
TrueSampleCount |
The total sample count of the source file. |
Name | Description | |
---|---|---|
|
IStreamedCompressedInfo() |
Name | Description | |
---|---|---|
|
~IStreamedCompressedInfo() |
Name | Description | ||
---|---|---|---|
|
CreateDecoder() |
Create the compression format dependent decoder object. |
|
|
FDecodeResul... |
Decode |
Decode the input compressed frame data into output PCMData buffer. |
|
DecompressToPCMBuffer ( |
Decompresses a frame of data to PCM buffer |
|
|
GetFrameSize() |
Return the size of the current compression frame |
|
|
const uint8 ... |
GetLoadedChunk ( |
Helper function for getting a chunk of compressed audio. |
|
GetMaxFrameSizeSamples() |
The size of the decode PCM buffer size. |
|
|
IncrementCurrentSampleCount ( |
Adds to the count of samples that have currently been decoded |
|
|
ParseHeader ( |
Parse the header information from the input source buffer data. |
|
|
PrepareToLoop() |
Optional method to allow decoder to prepare to loop. |
|
|
Read |
Reads from the internal source audio buffer stream of the given data size. |
|
|
WriteFromDecodedPCM |
Writes data from decoded PCM buffer, taking into account whether some PCM has been written before |
|
|
ZeroBuffer |
Zeroes the contents of a buffer |
Name | Description | ||
---|---|---|---|
|
EnableHalfRate ( |
Sets decode to half-rate |
|
|
ExpandFile ( |
Decompress an entire data file to a TArray |
|
|
GetCurrentChunkIndex() |
Gets the chunk index that was last read from (for Streaming Manager requests) |
|
|
GetCurrentChunkOffset() |
Gets the offset into the chunk that was last read to (for Streaming Manager priority) |
|
|
GetSourceBufferSize() |
Gets the size of the source buffer originally passed to the info class (bytes) |
|
|
int |
GetStreamBufferSize() |
Gets the preferred size for a streaming buffer for this decompression scheme |
|
ReadCompressedData |
Decompresses data to raw PCM data. |
|
|
ReadCompressedInfo ( |
Reads the header information of a compressed format |
|
|
SeekToTime ( |
Seeks to time (Some formats might not be seekable) |
|
|
StreamCompressedData |
Decompresses streamed data to raw PCM data. |
|
|
StreamCompressedInfoInternal ( |
Internal override implemented by subclasses. |
|
|
SupportsStreaming() |
Following functions are optional if streaming is supported //. |
|
|
UsesVorbisChannelOrdering() |
Whether the decompressed audio will be arranged using Vorbis' channel ordering See http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9 for details |