Skip to main content
Header: spf/api/modules/media_fmt_api_ext.h

Structures

payload_media_fmt_aac_t

Members
uint16_t
}
uint16_t
}
uint16_t
}
uint16_t
If this field is greater than 0, the PCE information follows this structure. Additional bits might be required for 32-bit alignment.}
uint32_t
This field must be equal to the sample rate of the AAC-LC decoder output. For MP4 or 3GP containers, this sample rate is indicated by the samplingFrequencyIndex field in the AudioSpecificConfig element. For ADTS format, this sample rate is indicated by the samplingFrequencyIndex in the ADTS fixed header. For ADIF format, this sample rate is indicated by the samplingFrequencyIndex in the program_config_element present in the ADIF header.}

aac_enc_cfg_t

Members
uint16_t
uint16_t

payload_media_fmt_alac_t

Members
uint32_t
The encoder frames per packet can be explicitly set, but for maximum compatibility, use the default encoder setting of 4096.}
uint8_t
}
uint8_t
}
uint8_t
(Currently not used.)}
uint8_t
(Currently not used.)}
uint8_t
(Currently not used.)}
uint8_t
}
uint16_t
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
Constants are extracted when channel layout information is present}

payload_media_fmt_ape_t

Members
uint16_t
}
uint16_t
The nBlocksPerFrame parameter value is based on the compression level.}
uint32_t
}
uint32_t
}
uint32_t
uint32_t
}
uint16_t
}
uint16_t
uint32_t
}
uint32_t
This flag is not part of the APE header.}

payload_media_fmt_flac_t

Members
uint16_t
}
uint16_t
uint16_t
It must be lessthan or equal to max_blk_size.}
uint16_t
If the minimum block size equals the maximum block size, a fixed block size stream is implied}
uint32_t
uint32_t
This should be greater than 0}
uint32_t
This should be greater than 0}

payload_media_fmt_vorbis_t

Members
uint32_t
}

payload_media_fmt_wmapro_t

Members
uint16_t
}
uint16_t
}
uint32_t
}
uint32_t
uint16_t
WMA Pro files have a payload of one block per bit stream packet.}
uint16_t
}
uint32_t
}
uint16_t
}
uint16_t
This field is ignored.}
uint32_t
This field is ignored.}

payload_media_fmt_wmastd_t

Members
uint16_t
}
uint16_t
}
uint32_t
}
uint32_t
uint16_t
All WMA files with a maximum packet size of 13376 are supported.}
uint16_t
uint32_t
}
uint16_t
}
uint16_t
}

sbc_enc_cfg_t

Members
uint32_t
uint32_t
int32_t
-Native mode indicates that encoding must be performed with the number of channels at the input.-If postprocessing outputs one-channel data, Mono mode is used. If postprocessing outputs two-channel data, Stereo mode is used.-The number of channels must not change during encoding. }
uint32_t
}

payload_media_fmt_amrwbplus_t

Members
uint32_t

amrnb_enc_cfg_t

Members
uint16_t
}
uint16_t

payload_media_fmt_eamr_t

Members
uint32_t

evrc_enc_cfg_t

Members
uint16_t
}
uint16_t
}
uint16_t
If bit 1=1, the maximum number of consecutive full rate frames is limited with numbers supplied in bits 2 to 10. If bit 1=0, the minimum number of non-full rate frames in between two full rate frames is forced to the number supplied in bits 2 to 10 In both cases of bit 1, if necessary, half rate is used to substitute full rate. Bits 15 to 10 are reserved and must all be set to 0.}
uint16_t
}

payload_media_fmt_g711_t

Members
uint32_t

ldac_enc_cfg_t

Members
uint32_t
The number of channels must not change during encoding }

v13k_enc_cfg_t

Members
uint16_t
}
uint16_t
}
uint16_t
uint16_t
If bit 1=1, the maximum number of consecutive full rate frames is limited with numbers supplied in bits 2 to 10. If bit 1=0, the minimum number of non-full rate frames in between two full rate frames is forced to the number supplied in bits 2 to 10 In both cases of bit 1, if necessary, half rate is used to substitute full rate. Bits 15 to 10 are reserved and must all be set to 0.}

amrwb_enc_cfg_t

Members
uint16_t
}
uint16_t

celt_enc_cfg_t

Members
uint16_t
}
uint16_t
Currently, this parameter is used to enable or disable the pitch analysis. In the future, it can be scaled to add more levels of complexity. value less than 2 - Disable pitch analysis Value > 2 - Enable pitch analysis}
uint16_t
This parameter is used to choose between the level of interframe predictions allowed while encoding. 0 Independent frames 1 Short-term interframe prediction allowed 2 Long-term prediction allowed}
uint16_t
Currently, this parameter is disabled. In the future, it can be enabled if use cases require it.}

evrcb_enc_cfg_t

Members
uint16_t
}
uint16_t
}
uint16_t
uint16_t

evrcwb_enc_cfg_t

Members
uint16_t
}
uint16_t
}
uint16_t
uint16_t
}

evs_enc_cfg_t

Members
uint32_t
uint32_t

payload_media_fmt_opus_t

Members
uint16_t
}
uint16_t
}
uint8_t
}
uint8_t
}
uint16_t
}
uint32_t
uint16_t
}
uint8_t
uint8_t
uint8_t
uint8_t
This member is valid only if mapping_family is not 0}
uint8_t
}

Type Definitions

payload_media_fmt_aac_t

AOT=17 is the ER AAC-LC format, which currently is not supported.

aac_enc_cfg_t

payload_media_fmt_alac_t

payload_media_fmt_ape_t

payload_media_fmt_flac_t

payload_media_fmt_vorbis_t

payload_media_fmt_wmapro_t

payload_media_fmt_wmastd_t

sbc_enc_cfg_t

payload_media_fmt_amrwbplus_t

Media format ID for the AMR-WB Plus format block.

amrnb_enc_cfg_t

payload_media_fmt_eamr_t

evrc_enc_cfg_t

payload_media_fmt_g711_t

ldac_enc_cfg_t

v13k_enc_cfg_t

amrwb_enc_cfg_t

celt_enc_cfg_t

evrcwb_enc_cfg_t

evs_enc_cfg_t

payload_media_fmt_opus_t

Macros

VOCODER_INVALID_RATE

VOCODER_ONE_EIGHTH_RATE

Enumeration for 1/8 vocoder rate.

VOCODER_QUARTER_RATE

Enumeration for 1/4 vocoder rate.

VOCODER_HALF_RATE

Enumeration for 1/2 vocoder rate.

VOCODER_FULL_RATE

Enumeration for full vocoder rate.

MEDIA_FMT_ID_AAC

Media format ID for AAC, which identifies both MPEG2 and MPEG4 AAC formats.

AAC_FORMAT_FLAG_ADTS

Enumeration for the audio data transport stream AAC format.

AAC_FORMAT_FLAG_LOAS

Enumeration for the low overhead audio stream AAC format.

AAC_FORMAT_FLAG_ADIF

Enumeration for the audio data interchange format AAC format.

AAC_FORMAT_FLAG_RAW

Enumeration for the raw AAC format.

AAC_FORMAT_FLAG_LATM

Enumeration for the low overhead audio transport multiplex AAC format.

AAC_AOT_LC

Enumeration for the AAC low complexity audio object type:

AAC_AOT_SBR

Enumeration for the AAC spectral band replication AOT:

AAC_AOT_PS

Enumeration for the AAC parametric stereo AOT:

AAC_AOT_BSAC

Enumeration for the bit-sliced arithmetic coding AOT:

MEDIA_FMT_ID_AC3

Media format ID for AC3 streams.

MEDIA_FMT_ID_EAC3

Media format ID for EAC3 streams.

MEDIA_FMT_ID_DTS

MEDIA_FMT_ID_ATRAC

MEDIA_FMT_ID_DTHD

MEDIA_FMT_ID_MAT

MEDIA_FMT_ID_ALAC

Media format ID for ALAC streams.

MEDIA_FMT_ID_APE

Media format ID for APE streams.

MEDIA_FMT_ID_FLAC

Media format ID for FLAC streams.

MEDIA_FMT_ID_VORBIS

Media format ID for Vorbis streams.

MEDIA_FMT_ID_WMAPRO

Media format ID for the WMAPRO streams.

MEDIA_FMT_ID_WMASTD

Media format ID for the WMASTD streams.

MEDIA_FMT_ID_SBC

Media format ID for the SBC.

MEDIA_FMT_SBC_CHANNEL_MODE_MONO

Enumeration for SBC channel Mono mode.

MEDIA_FMT_SBC_CHANNEL_MODE_STEREO

Enumeration for SBC channel Stereo mode.

MEDIA_FMT_SBC_CHANNEL_MODE_DUAL_MONO

Enumeration for SBC channel Dual Mono mode.

MEDIA_FMT_SBC_CHANNEL_MODE_JOINT_STEREO

Enumeration for SBC channel Joint Stereo mode.

MEDIA_FMT_SBC_ALLOCATION_METHOD_LOUDNESS

Enumeration for SBC bit allocation method = loudness.

MEDIA_FMT_SBC_ALLOCATION_METHOD_SNR

Enumeration for SBC bit allocation method = SNR.

MEDIA_FMT_ID_MP3

Media format ID for MP3 streams.

MEDIA_FMT_ID_MP2

Media format ID for MP2.

MEDIA_FMT_ID_AMRWBPLUS

Media format ID for the amrwbplus streams.

MEDIA_FMT_ID_EAMR

Media format ID for AMRNB streams.

MEDIA_FMT_ID_AMRNB_IF2

MEDIA_FMT_ID_AMRNB_MODEM

MEDIA_FMT_ID_AMRNB_FS

AMRNB_FS_ENCODE_MODE_MR475

Enumeration for 4.75 kbps AMR-NB Encoding mode.

AMRNB_FS_ENCODE_MODE_MR515

Enumeration for 5.15 kbps AMR-NB Encoding mode.

AMRNB_FS_ENCODE_MODE_MMR59

Enumeration for 5.90 kbps AMR-NB Encoding mode.

AMRNB_FS_ENCODE_MODE_MMR67

Enumeration for 6.70 kbps AMR-NB Encoding mode.

AMRNB_FS_ENCODE_MODE_MMR74

Enumeration for 7.40 kbps AMR-NB Encoding mode.

AMRNB_FS_ENCODE_MODE_MMR795

Enumeration for 7.95 kbps AMR-NB Encoding mode.

AMRNB_FS_ENCODE_MODE_MMR102

Enumeration for 10.20 kbps AMR-NB Encoding mode.

AMRNB_FS_ENCODE_MODE_MMR122

Enumeration for 12.20 kbps AMR-NB Encoding mode.

AMRNB_FS_DTX_MODE_OFF

Enumeration for disabling AMR-NB DTX mode.

AMRNB_FS_DTX_MODE_VAD1

Enumeration for enabling AMR-NB DTX mode VAD1.

AMRNB_FS_DTX_MODE_VAD2

Enumeration for enabling AMR-NB DTX mode VAD2.

AMRNB_FS_DTX_MODE_AUTO

Enumeration for enabling AMR-NB automatic DTX mode.

MEDIA_FMT_ID_EVRC

Media format ID for EVRC streams.

MEDIA_FMT_ID_EVRC_FS

MEDIA_FMT_ID_HR

Media format ID for HR streams.

MEDIA_FMT_ID_FR

Media format ID for FR streams.

MEDIA_FMT_ID_FR_FS

MEDIA_FMT_ID_EFR

Media format ID for EFR streams.

MEDIA_FMT_ID_G711_ALAW

Media format ID for G711 streams.

MEDIA_FMT_ID_G711_MLAW

MEDIA_FMT_ID_G711_ALAW_V2

MEDIA_FMT_ID_G711_MLAW_V2

MEDIA_FMT_ID_G711_ALAW_FS

MEDIA_FMT_ID_G711_MLAW_FS

MEDIA_FMT_ID_G722

Media format ID for G722 streams.

MEDIA_FMT_ID_G729AB

Media format ID for G729AB streams.

MEDIA_FMT_ID_LDAC

Media format ID for LDAC streams.

LDAC_CHANNEL_MODE_STEREO

Enumeration for Stereo mode on the LDAC channel.

LDAC_CHANNEL_MODE_DUAL_CHANNEL

Enumeration for Dual Channel mode on the LDAC channel.

LDAC_CHANNEL_MODE_MONO

Enumeration for Mono mode on the LDAC channel.

MEDIA_FMT_ID_V13K

MEDIA_FMT_ID_V13K_FS

V13K_FS_ENCODE_MODE_MR1440

Enumeration for 14.4 kbps V13K Encoding mode.

V13K_FS_ENCODE_MODE_MR1220

Enumeration for 12.2 kbps V13K Encoding mode.

V13K_FS_ENCODE_MODE_MR1120

Enumeration for 11.2 kbps V13K Encoding mode.

V13K_FS_ENCODE_MODE_MR90

Enumeration for 9.0 kbps V13K Encoding mode.

V13K_FS_ENCODE_MODE_MR720

Enumeration for 7.2 kbps V13K Encoding mode.

MEDIA_FMT_ID_AMRWB

Media format ID for AMRWB streams.

MEDIA_FMT_ID_AMRWB_FS

AMRWB_FS_ENCODE_MODE_MR66

Enumeration for 6.60 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR885

Enumeration for 8.85 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR1265

Enumeration for 12.65 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR1425

Enumeration for 14.25 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR1585

Enumeration for 15.85 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR1825

Enumeration for 18.25 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR1985

Enumeration for 19.85 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR2305

Enumeration for 23.05 kbps AMR-WB Encoding mode.

AMRWB_FS_ENCODE_MODE_MR2385

Enumeration for 23.85 kbps AMR-WB Encoding mode.

MEDIA_FMT_ID_CELT

Media format ID for the CELT.

MEDIA_FMT_ID_EVRCB_FS

Media format ID for FOURGV streams.

MEDIA_FMT_ID_EVRCWB_FS

MEDIA_FMT_ID_4GV_NB_MODEM

MEDIA_FMT_ID_4GV_WB_MODEM

MEDIA_FMT_ID_4GV_NW_MODEM

MEDIA_FMT_ID_4GV_NW

MEDIA_FMT_ID_EVRC_NW_2K

EVRCB_FS_ENCODE_MODE_MR930

Enumeration for 9.3 kbps EVRC-B Encoding mode.

EVRCB_FS_ENCODE_MODE_MR850

Enumeration for 8.5 kbps EVRC-B Encoding mode.

EVRCB_FS_ENCODE_MODE_MR750

Enumeration for 7.5 kbps EVRC-B Encoding mode.

EVRCB_FS_ENCODE_MODE_MR700

Enumeration for 7.0 kbps EVRC-B Encoding mode.

EVRCB_FS_ENCODE_MODE_MR660

Enumeration for 6.6 kbps EVRC-B Encoding mode.

EVRCB_FS_ENCODE_MODE_MR620

Enumeration for 6.2 kbps EVRC-B Encoding mode.

EVRCB_FS_ENCODE_MODE_MR580

Enumeration for 5.8 kbps EVRC-B Encoding mode.

EVRCB_FS_ENCODE_MODE_MR480

Enumeration for 4.8 kbps EVRC-B Encoding mode.

EVRCWB_FS_ENCODE_MODE_MR850

Enumeration for 8.5 kbps EVRC-WB Encoding mode.

EVRCWB_FS_ENCODE_MODE_MR930

Enumeration for 9.3 kbps EVRC-WB Encoding mode.

EVRCWB_FS_ENCODE_MODE_MR480

Enumeration for 4.8 kbps EVRC-WB Encoding mode.

MEDIA_FMT_ID_EVS

Media format ID for EVRC streams.

EVS_CODEC_MODE_0660

Enumeration for 06.60 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_0885

Enumeration for 08.85 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_1265

Enumeration for 12.65 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_1425

Enumeration for 14.25 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_1585

Enumeration for 15.85 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_1825

Enumeration for 18.25 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_1985

Enumeration for 19.85 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_2305

Enumeration for 23.05 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_2385

Enumeration for 23.85 kbps, AMR-WB IO (WB).

EVS_CODEC_MODE_0590

Enumeration for 05.90 kbps, EVS (NB, WB).

EVS_CODEC_MODE_0720

Enumeration for 07.20 kbps, EVS (NB, WB).

EVS_CODEC_MODE_0800

Enumeration for 08.00 kbps, EVS (NB, WB).

EVS_CODEC_MODE_0960

Enumeration for 09.60 kbps, EVS (NB, WB, SWB).

EVS_CODEC_MODE_1320

Enumeration for 13.20 kbps, EVS (NB, WB, SWB).

EVS_CODEC_MODE_1640

Enumeration for 16.40 kbps, EVS (NB, WB, SWB, FB).

EVS_CODEC_MODE_2440

Enumeration for 24.40 kbps, EVS (NB, WB, SWB, FB)

EVS_CODEC_MODE_3200

Enumeration for 32.00 kbps, EVS (WB, SWB, FB).

EVS_CODEC_MODE_4800

Enumeration for 48.00 kbps, EVS (WB, SWB, FB).

EVS_CODEC_MODE_6400

Enumeration for 64.00 kbps, EVS (WB, SWB, FB).

EVS_CODEC_MODE_9600

Enumeration for 96.00 kbps, EVS (WB, SWB, FB).

EVS_CODEC_MODE_12800

Enumeration for 128.00 kbps, EVS (WB, SWB, FB).

MEDIA_FMT_ID_OPUS

Media format ID for OPUS streams.