carb/audio/IAudioData.h

↰ Parent directory: carb/audio/

The audio data management interface.

Source: carb/audio/IAudioData.h

Included By

• carb/audio/AudioUtils.h: Inline utility functions for audio processing.

• carb/audio/IAudioPlayback.h: The audio playback interface.

• carb/audio/IAudioUtils.h: General audio utilities.

• carb/audio/AudioStreamerUtils.h: Helper classes for streaming data from carb::audio::IAudioPlayback.

• carb/audio/IAudioGroup.h: The audio group interface.

Namespaces

• carb: The main Carbonite namespace.

• carb::audio: Audio playback and capture.

Classes

• carb::audio::CodecInfo: information about a codec for a single sample format.

• carb::audio::CodecState: stores information on the current decoding or encoding state of a carb::audio::SoundData object.

• carb::audio::CodecStateDesc: a descriptor for the codec state that should be created.

• carb::audio::DecodeStateDesc: a descriptor of how to create a sound decode state object with createCodecState().

• carb::audio::EncodeStateDesc: a descriptor for creating an encoder state object.

• carb::audio::EventPoint: a event point parsed from a data file.

• carb::audio::FlacEncoderSettings: Settings specific to FLAC file encoding.

• carb::audio::IAudioData: interface to manage audio data in general.

• carb::audio::OpusEncoderSettings: Settings specific to carb::audio::eOpus audio encoding.

• carb::audio::PeakVolumes: used to retrieve the peak volume information for a sound data object.

• carb::audio::SoundData: a buffer of sound data.

• carb::audio::SoundDataLoadDesc: a descriptor for the sound data to be loaded.

• carb::audio::SoundLoadParameters: additional load parameters for sound data objects.

• carb::audio::VorbisEncoderSettings: Settings specific to Vorbis file encoding.

• carb::audio::WaveEncoderSettings: Settings specific to wave file encoding.

Enums

• carb::audio::CodecPart: names to identify the different parts of a codec.

• carb::audio::FlacFileType: The file type used to store FLAC encoded audio.

• carb::audio::OpusCodecUsage: The intended usage for audio.

Typedefs

• carb::audio::CodecCaps: capabilities flags for codecs.

• carb::audio::DataFlags: flags used for the createData() function.

• carb::audio::DecodeStateFlags: Flags that alter the decoding behavior for carb::audio::SoundData objects.

• carb::audio::EncodeStateFlags: flags to control the behaviour of the encoder.

• carb::audio::EventPointId: base type for an event point identifier.

• carb::audio::OpusEncoderFlags: Flags to use when encoding audio in carb::audio::eOpus.

• carb::audio::SoundDataDestructionCallback: An optional callback that gets fired when the carb::audio::SoundData’s final reference is released.

• carb::audio::SoundDataReadCallback: callback function prototype for reading data for fDataFlagUserDecode sound data objects.

• carb::audio::SoundDataSetPosCallback: an optional callback to reposition the data pointer for a user decoded stream.

Variables

• carb::audio::fCodecCapsCompressed: capabilities flag to indicate that the format is compressed data (ie: block oriented or otherwise).

• carb::audio::fCodecCapsHasAccurateAvailableValue: capabilities flag to indicate that the codec can calculate a frame accurate count of remaining data.

• carb::audio::fCodecCapsHasFrameAccuratePosition: capabilities flag to indicate that the codec can calculate and set a frame accurate position.

• carb::audio::fCodecCapsRequiresAdditionalParameters: capabilities flag to indicate that the codec requires the use of additional parameters through the encoderSettings value in the encoder state descriptor object.

• carb::audio::fCodecCapsSupportsAdditionalParameters: capabilities flag to indicate that the codec supports the use of additional parameters through the encoderSettings value in the encoder state descriptor object.

• carb::audio::fCodecCapsSupportsDecode: capabilities flag to indicate that the codec supports decoding from the given format.

• carb::audio::fCodecCapsSupportsEncode: capabilities flag to indicate that the codec supports encoding to the given format.

• carb::audio::fCodecCapsSupportsSetPosition: capabilities flag to indicate that the codec supports setting the position within the stream.

• carb::audio::fDataFlagCalcPeaks: flag to indicate that the peak volumes for each channel should be calculated for the sound data object as its data is decoded at creation time or when streaming into the sound data object.

• carb::audio::fDataFlagDecode: decode the sound’s full data into PCM at load time.

• carb::audio::fDataFlagEmpty: create the sound data object as empty.

• carb::audio::fDataFlagFormatAuto: auto detect the format from the file header data.

• carb::audio::fDataFlagFormatMask: mask to indicate which flag bits are reserved to specify the file format flags.

• carb::audio::fDataFlagFormatPcm: the data was loaded as WAV PCM.

• carb::audio::fDataFlagFormatRaw: force raw PCM data to be loaded.

• carb::audio::fDataFlagInMemory: load the file data from a blob in memory.

• carb::audio::fDataFlagNoName: don’t store the asset name or filename in the new sound data object.

• carb::audio::fDataFlagSkipEventPoints: This flag indicates that the event points should be ignored when decoding the sound.

• carb::audio::fDataFlagSkipMetaData: This flag indicates that the metadata should be ignored when opening the sound.

• carb::audio::fDataFlagStream: stream the audio data at runtime.

• carb::audio::fDataFlagUserDecode: use the user-decode callbacks when loading or streaming this data.

• carb::audio::fDataFlagUserMemory: when the carb::audio::fDataFlagInMemory flag is also used, this indicates that the original memory blob should be directly referenced in the new sound data object instead of copying it.

• carb::audio::fDecodeStateFlagCoarseSeek: This flag indicates that frame accurate seeking is not needed and the decoder may skip additional work that is required for frame-accurate seeking.

• carb::audio::fDecodeStateFlagForceParse: If this flag is set, the header information of the file will be parsed every time createCodecState() is called.

• carb::audio::fDecodeStateFlagOptimizeSeek: If this flag is set and the encoded format supports this behavior, indexes for seek optimization will be generated when the carb::audio::CodecState is created.

• carb::audio::fDecodeStateFlagSkipEventPoints: This flag indicates that the event points should be ignored when decoding the sound.

• carb::audio::fDecodeStateFlagSkipMetaData: This flag indicates that the metadata should be ignored when decoding the sound.

• carb::audio::fEncodeStateFlagNoExpandBuffer: Avoid expanding the target carb::audio::SoundData if it runs out of space.

• carb::audio::fEncodeStateFlagStripEventPoints: Don’t copy the event point information into the target carb::audio::SoundData.

• carb::audio::fEncodeStateFlagStripMetaData: Don’t copy the metdata information into the target carb::audio::SoundData.

• carb::audio::fEncodeStateFlagStripPeaks: Don’t copy the peaks information into the target carb::audio::SoundData.

• carb::audio::fOpusEncoderFlagConstantBitrate: Specify whether the encoder is prevented from producing variable bitrate audio.

• carb::audio::fOpusEncoderFlagDisablePrediction: Disable prediction so that any two blocks of Opus data are (almost completely) independent.

• carb::audio::fOpusEncoderFlagDiscontinuousTransmission: This enables a mode in the encoder where silence will only produce one frame every 400ms.

• carb::audio::fOpusEncoderFlagLowLatency: Optimize the encoder for minimal latency at the cost of quality.

• carb::audio::fOpusEncoderFlagNativeChannelOrder: If this is true, the encoder will expect its input to be in Vorbis channel order.

• carb::audio::kEventPointInvalidFrame: an invalid frame offset for an event point.

• carb::audio::kEventPointLoopInfinite: This indicates that an event point should loop infinitely.

• carb::audio::kEventPointTableClear: special value for setEventPoints() to indicate that the event point table should be cleared instead of adding or removing individual event points.

• carb::audio::kInstancesUnlimited: special value to indicate that the maximum instance count for a sound or sound group is unlimited.

• carb::audio::kMemoryLimitThreshold: the memory limit threshold for determining if a sound should be decoded into memory.

• carb::audio::kMetaDataTagAlbum: These are the metadata tags that can be written to RIFF (.wav) files and also have specified usage under the Vorbis Comment metadata format standard (used by .ogg and .flac).

• carb::audio::kMetaDataTagArchivalLocation: These are the metadata tags that can be written to RIFF (.wav) files.

• carb::audio::kMetaDataTagArtist: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagAudioSourceWebsite: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagBpm: These are extra metadata tags that are available with the ID3v2 metadata tag (used by some .mp3 files).

• carb::audio::kMetaDataTagClearAllTags: This is a magic value that can be passed to setMetaData() to remove all tags from the metadata table for that sound.

• carb::audio::kMetaDataTagComment: These are metadata tags specified as part of the ID3v1 comment format (used by some .mp3 files).

• carb::audio::kMetaDataTagCommissioned: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagComposer: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagContact: Standard metadata tag.

• carb::audio::kMetaDataTagCopyright: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagCreationDate: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagCropped: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagDescription: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagDimensions: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagDisc: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagDpi: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagEditor: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagEncoder: If a carb::audio::SoundData is being encoded with metadata present, this tag will automatically be added, with the value being the encoder software used.

• carb::audio::kMetaDataTagEndTime: End time of the music.

• carb::audio::kMetaDataTagEngineer: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagFileName: The original file name for this file.

• carb::audio::kMetaDataTagGenre: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagInitialKey: The musical key that the audio starts with.

• carb::audio::kMetaDataTagInternetArtistWebsite: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagInternetCommercialInformationUrl: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagInternetCopyrightUrl: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagInternetRadioStationName: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagInternetRadioStationOwner: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagInternetRadioStationUrl: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagISRC: This tag unfortunately has a different meaning in the two formats.

• carb::audio::kMetaDataTagKeywords: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagLanguage: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagLicense: These are metadata tags specified usage under the Vorbis Comment metadata format standard (used by .ogg and .flac), but are not supported on RIFF (.wav) files.

• carb::audio::kMetaDataTagLightness: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagLocation: Standard metadata tag.

• carb::audio::kMetaDataTagMedium: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagOrganization: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagOriginalAlbum: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagOriginalPerformer: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagOriginalWriter: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagOriginalYear: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagOwner: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagPaletteSetting: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagPaymentUrl: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagPerformer: Standard metadata tag.

• carb::audio::kMetaDataTagPlaylistDelay: Delay between songs in a playlist in milliseconds.

• carb::audio::kMetaDataTagPublisher: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagRecordingDate: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagSharpness: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagSourceForm: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagSpeed: Speed or tempo of the music.

• carb::audio::kMetaDataTagStartTime: Start time of the music.

• carb::audio::kMetaDataTagSubGenre: This is part of the ID3v1.2 tag.

• carb::audio::kMetaDataTagSubject: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagTechnician: Standard RIFF metadata tag.

• carb::audio::kMetaDataTagTermsOfUse: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagTitle: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagTrackNumber: Standard Vorbis metadata tag.

• carb::audio::kMetaDataTagVersion: Standard metadata tag.

• carb::audio::kMetaDataTagWebsite: Standard ID3v2 metadata tag.

• carb::audio::kMetaDataTagWriter: Standard RIFF metadata tag.

• carb::audio::kOpusBitrateMax: Encode carb::audio::eOpus with the maximum possible bitrate.