This module contains structure definitions for the representation of FLAC format components in memory. These are the basic structures used by the rest of the interfaces. More...
Classes | |
| struct | FLAC__EntropyCodingMethod_PartitionedRiceContents |
| struct | FLAC__EntropyCodingMethod_PartitionedRice |
| struct | FLAC__EntropyCodingMethod |
| struct | FLAC__Subframe_Constant |
| struct | FLAC__Subframe_Verbatim |
| struct | FLAC__Subframe_Fixed |
| struct | FLAC__Subframe_LPC |
| struct | FLAC__Subframe |
| struct | FLAC__FrameHeader |
| struct | FLAC__FrameFooter |
| struct | FLAC__Frame |
| struct | FLAC__StreamMetadata_StreamInfo |
| struct | FLAC__StreamMetadata_Padding |
| struct | FLAC__StreamMetadata_Application |
| struct | FLAC__StreamMetadata_SeekPoint |
| struct | FLAC__StreamMetadata_SeekTable |
| struct | FLAC__StreamMetadata_VorbisComment_Entry |
| struct | FLAC__StreamMetadata_VorbisComment |
| struct | FLAC__StreamMetadata_CueSheet_Index |
| struct | FLAC__StreamMetadata_CueSheet_Track |
| struct | FLAC__StreamMetadata_CueSheet |
| struct | FLAC__StreamMetadata_Picture |
| struct | FLAC__StreamMetadata_Unknown |
| struct | FLAC__StreamMetadata |
Macros | |
| #define | FLAC__MAX_METADATA_TYPE_CODE (126u) |
| #define | FLAC__MIN_BLOCK_SIZE (16u) |
| #define | FLAC__MAX_BLOCK_SIZE (65535u) |
| #define | FLAC__SUBSET_MAX_BLOCK_SIZE_48000HZ (4608u) |
| #define | FLAC__MAX_CHANNELS (8u) |
| #define | FLAC__MIN_BITS_PER_SAMPLE (4u) |
| #define | FLAC__MAX_BITS_PER_SAMPLE (32u) |
| #define | FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE (24u) |
| #define | FLAC__MAX_SAMPLE_RATE (655350u) |
| #define | FLAC__MAX_LPC_ORDER (32u) |
| #define | FLAC__SUBSET_MAX_LPC_ORDER_48000HZ (12u) |
| #define | FLAC__MIN_QLP_COEFF_PRECISION (5u) |
| #define | FLAC__MAX_QLP_COEFF_PRECISION (15u) |
| #define | FLAC__MAX_FIXED_ORDER (4u) |
| #define | FLAC__MAX_RICE_PARTITION_ORDER (15u) |
| #define | FLAC__SUBSET_MAX_RICE_PARTITION_ORDER (8u) |
| #define | FLAC__STREAM_SYNC_LENGTH (4u) |
| #define | FLAC__STREAM_METADATA_STREAMINFO_LENGTH (34u) |
| #define | FLAC__STREAM_METADATA_SEEKPOINT_LENGTH (18u) |
| #define | FLAC__STREAM_METADATA_HEADER_LENGTH (4u) |
Detailed Description
This module contains structure definitions for the representation of FLAC format components in memory. These are the basic structures used by the rest of the interfaces.
First, you should be familiar with the FLAC format. Many of the values here follow directly from the specification. As a user of libFLAC, the interesting parts really are the structures that describe the frame header and metadata blocks.
The format structures here are very primitive, designed to store information in an efficient way. Reading information from the structures is easy but creating or modifying them directly is more complex. For the most part, as a user of a library, editing is not necessary; however, for metadata blocks it is, so there are convenience functions provided in the metadata module to simplify the manipulation of metadata blocks.
- Note
- It's not the best convention, but symbols ending in _LEN are in bits and _LENGTH are in bytes. _LENGTH symbols are #defines instead of global variables because they are usually used when declaring byte arrays and some compilers require compile-time knowledge of array sizes when declared on the stack.
Macro Definition Documentation
◆ FLAC__MAX_BITS_PER_SAMPLE
| #define FLAC__MAX_BITS_PER_SAMPLE (32u) |
The maximum sample resolution permitted by the format.
◆ FLAC__MAX_BLOCK_SIZE
| #define FLAC__MAX_BLOCK_SIZE (65535u) |
The maximum block size, in samples, permitted by the format.
◆ FLAC__MAX_CHANNELS
| #define FLAC__MAX_CHANNELS (8u) |
The maximum number of channels permitted by the format.
◆ FLAC__MAX_FIXED_ORDER
| #define FLAC__MAX_FIXED_ORDER (4u) |
The maximum order of the fixed predictors permitted by the format.
◆ FLAC__MAX_LPC_ORDER
| #define FLAC__MAX_LPC_ORDER (32u) |
The maximum LPC order permitted by the format.
◆ FLAC__MAX_METADATA_TYPE_CODE
| #define FLAC__MAX_METADATA_TYPE_CODE (126u) |
The largest legal metadata type code.
◆ FLAC__MAX_QLP_COEFF_PRECISION
| #define FLAC__MAX_QLP_COEFF_PRECISION (15u) |
The maximum quantized linear predictor coefficient precision permitted by the format.
◆ FLAC__MAX_RICE_PARTITION_ORDER
| #define FLAC__MAX_RICE_PARTITION_ORDER (15u) |
The maximum Rice partition order permitted by the format.
◆ FLAC__MAX_SAMPLE_RATE
| #define FLAC__MAX_SAMPLE_RATE (655350u) |
The maximum sample rate permitted by the format. The value is ((2 ^ 16) - 1) * 10; see FLAC format as to why.
◆ FLAC__MIN_BITS_PER_SAMPLE
| #define FLAC__MIN_BITS_PER_SAMPLE (4u) |
The minimum sample resolution permitted by the format.
◆ FLAC__MIN_BLOCK_SIZE
| #define FLAC__MIN_BLOCK_SIZE (16u) |
The minimum block size, in samples, permitted by the format.
◆ FLAC__MIN_QLP_COEFF_PRECISION
| #define FLAC__MIN_QLP_COEFF_PRECISION (5u) |
The minimum quantized linear predictor coefficient precision permitted by the format.
◆ FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE
| #define FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE (24u) |
The maximum sample resolution permitted by libFLAC.
- Warning
- FLAC__MAX_BITS_PER_SAMPLE is the limit of the FLAC format. However, the reference encoder/decoder is currently limited to 24 bits because of prevalent 32-bit math, so make sure and use this value when appropriate.
◆ FLAC__STREAM_METADATA_HEADER_LENGTH
| #define FLAC__STREAM_METADATA_HEADER_LENGTH (4u) |
The total stream length of a metadata block header in bytes.
◆ FLAC__STREAM_METADATA_SEEKPOINT_LENGTH
| #define FLAC__STREAM_METADATA_SEEKPOINT_LENGTH (18u) |
The total stream length of a seek point in bytes.
◆ FLAC__STREAM_METADATA_STREAMINFO_LENGTH
| #define FLAC__STREAM_METADATA_STREAMINFO_LENGTH (34u) |
The total stream length of the STREAMINFO block in bytes.
◆ FLAC__STREAM_SYNC_LENGTH
| #define FLAC__STREAM_SYNC_LENGTH (4u) |
The length of the FLAC signature in bytes.
◆ FLAC__SUBSET_MAX_BLOCK_SIZE_48000HZ
| #define FLAC__SUBSET_MAX_BLOCK_SIZE_48000HZ (4608u) |
The maximum block size, in samples, permitted by the FLAC subset for sample rates up to 48kHz.
◆ FLAC__SUBSET_MAX_LPC_ORDER_48000HZ
| #define FLAC__SUBSET_MAX_LPC_ORDER_48000HZ (12u) |
The maximum LPC order permitted by the FLAC subset for sample rates up to 48kHz.
◆ FLAC__SUBSET_MAX_RICE_PARTITION_ORDER
| #define FLAC__SUBSET_MAX_RICE_PARTITION_ORDER (8u) |
The maximum Rice partition order permitted by the FLAC Subset.
Enumeration Type Documentation
◆ FLAC__ChannelAssignment
◆ FLAC__EntropyCodingMethodType
An enumeration of the available entropy coding methods.
◆ FLAC__FrameNumberType
◆ FLAC__MetadataType
| enum FLAC__MetadataType |
An enumeration of the available metadata block types.
| Enumerator | |
|---|---|
| FLAC__METADATA_TYPE_STREAMINFO | STREAMINFO block |
| FLAC__METADATA_TYPE_PADDING | PADDING block |
| FLAC__METADATA_TYPE_APPLICATION | APPLICATION block |
| FLAC__METADATA_TYPE_SEEKTABLE | SEEKTABLE block |
| FLAC__METADATA_TYPE_VORBIS_COMMENT | VORBISCOMMENT block (a.k.a. FLAC tags) |
| FLAC__METADATA_TYPE_CUESHEET | CUESHEET block |
| FLAC__METADATA_TYPE_PICTURE | PICTURE block |
| FLAC__METADATA_TYPE_UNDEFINED | marker to denote beginning of undefined type range; this number will increase as new metadata types are added |
| FLAC__MAX_METADATA_TYPE | No type will ever be greater than this. There is not enough room in the protocol block. |
◆ FLAC__StreamMetadata_Picture_Type
An enumeration of the PICTURE types (see FLAC__StreamMetadataPicture and id3 v2.4 APIC tag).
◆ FLAC__SubframeType
| enum FLAC__SubframeType |
Function Documentation
◆ FLAC__format_blocksize_is_subset()
| FLAC_API FLAC__bool FLAC__format_blocksize_is_subset | ( | unsigned | blocksize, |
| unsigned | sample_rate ) |
Tests that a blocksize at the given sample rate is valid for the FLAC subset.
- Parameters
-
blocksize The blocksize to test for compliance. sample_rate The sample rate is needed, since the valid subset blocksize depends on the sample rate.
- Return values
-
FLAC__bool trueif the given blocksize conforms to the specification for the subset at the given sample rate, elsefalse.
◆ FLAC__format_cuesheet_is_legal()
| FLAC_API FLAC__bool FLAC__format_cuesheet_is_legal | ( | const FLAC__StreamMetadata_CueSheet * | cue_sheet, |
| FLAC__bool | check_cd_da_subset, | ||
| const char ** | violation ) |
Check a cue sheet to see if it conforms to the FLAC specification. See the format specification for limits on the contents of the cue sheet.
- Parameters
-
cue_sheet A pointer to an existing cue sheet to be checked. check_cd_da_subset If true, check CUESHEET against more stringent requirements for a CD-DA (audio) disc.violation Address of a pointer to a string. If there is a violation, a pointer to a string explanation of the violation will be returned here. violation may be NULLif you don't need the returned string. Do not free the returned string; it will always point to static data. \assert
- Return values
-
FLAC__bool falseif cue sheet is illegal, elsetrue.
◆ FLAC__format_picture_is_legal()
| FLAC_API FLAC__bool FLAC__format_picture_is_legal | ( | const FLAC__StreamMetadata_Picture * | picture, |
| const char ** | violation ) |
Check picture data to see if it conforms to the FLAC specification. See the format specification for limits on the contents of the PICTURE block.
- Parameters
-
picture A pointer to existing picture data to be checked. violation Address of a pointer to a string. If there is a violation, a pointer to a string explanation of the violation will be returned here. violation may be NULLif you don't need the returned string. Do not free the returned string; it will always point to static data. \assertpicture != NULL
- Return values
-
FLAC__bool falseif picture data is illegal, elsetrue.
◆ FLAC__format_sample_rate_is_subset()
| FLAC_API FLAC__bool FLAC__format_sample_rate_is_subset | ( | unsigned | sample_rate | ) |
Tests that a sample rate is valid for the FLAC subset. The subset rules for valid sample rates are slightly more complex since the rate has to be expressible completely in the frame header.
- Parameters
-
sample_rate The sample rate to test for compliance.
- Return values
-
FLAC__bool trueif the given sample rate conforms to the specification for the subset, elsefalse.
◆ FLAC__format_sample_rate_is_valid()
| FLAC_API FLAC__bool FLAC__format_sample_rate_is_valid | ( | unsigned | sample_rate | ) |
Tests that a sample rate is valid for FLAC.
- Parameters
-
sample_rate The sample rate to test for compliance.
- Return values
-
FLAC__bool trueif the given sample rate conforms to the specification, elsefalse.
◆ FLAC__format_seektable_is_legal()
| FLAC_API FLAC__bool FLAC__format_seektable_is_legal | ( | const FLAC__StreamMetadata_SeekTable * | seek_table | ) |
Check a seek table to see if it conforms to the FLAC specification. See the format specification for limits on the contents of the seek table.
- Parameters
-
seek_table A pointer to a seek table to be checked. \assert seek_table != NULL
- Return values
-
FLAC__bool falseif seek table is illegal, elsetrue.
◆ FLAC__format_seektable_sort()
| FLAC_API unsigned FLAC__format_seektable_sort | ( | FLAC__StreamMetadata_SeekTable * | seek_table | ) |
Sort a seek table's seek points according to the format specification. This includes a "unique-ification" step to remove duplicates, i.e. seek points with identical sample_number values. Duplicate seek points are converted into placeholder points and sorted to the end of the table.
- Parameters
-
seek_table A pointer to a seek table to be sorted. \assert seek_table != NULL
- Return values
-
unsigned The number of duplicate seek points converted into placeholders.
◆ FLAC__format_vorbiscomment_entry_is_legal()
| FLAC_API FLAC__bool FLAC__format_vorbiscomment_entry_is_legal | ( | const FLAC__byte * | entry, |
| unsigned | length ) |
Check a Vorbis comment entry to see if it conforms to the Vorbis comment specification.
Vorbis comment entries must be of the form 'name=value', and 'name' and 'value' must be legal according to FLAC__format_vorbiscomment_entry_name_is_legal() and FLAC__format_vorbiscomment_entry_value_is_legal() respectively.
- Parameters
-
entry An entry to be checked. length The length of entry in bytes. \assert
- Return values
-
FLAC__bool falseif entry name is illegal, elsetrue.
◆ FLAC__format_vorbiscomment_entry_name_is_legal()
| FLAC_API FLAC__bool FLAC__format_vorbiscomment_entry_name_is_legal | ( | const char * | name | ) |
Check a Vorbis comment entry name to see if it conforms to the Vorbis comment specification.
Vorbis comment names must be composed only of characters from [0x20-0x3C,0x3E-0x7D].
- Parameters
-
name A NUL-terminated string to be checked. \assert
- Return values
-
FLAC__bool falseif entry name is illegal, elsetrue.
◆ FLAC__format_vorbiscomment_entry_value_is_legal()
| FLAC_API FLAC__bool FLAC__format_vorbiscomment_entry_value_is_legal | ( | const FLAC__byte * | value, |
| unsigned | length ) |
Check a Vorbis comment entry value to see if it conforms to the Vorbis comment specification.
Vorbis comment values must be valid UTF-8 sequences.
- Parameters
-
value A string to be checked. length A the length of value in bytes. May be (unsigned)(-1) to indicate that value is a plain UTF-8 NUL-terminated string. \assert
- Return values
-
FLAC__bool falseif entry name is illegal, elsetrue.
Variable Documentation
◆ [] [1/2]
| FLAC__StreamMetadata_Application { ... } ::application |
◆ application [2/2]
| FLAC__StreamMetadata_Application FLAC__StreamMetadata::application |
◆ bits_per_sample [1/2]
| unsigned FLAC__FrameHeader::bits_per_sample |
The sample resolution.
◆ bits_per_sample [2/2]
| unsigned FLAC__StreamMetadata_StreamInfo::bits_per_sample |
◆ blocksize
| unsigned FLAC__FrameHeader::blocksize |
The number of samples per subframe.
◆ capacity_by_order
| unsigned FLAC__EntropyCodingMethod_PartitionedRiceContents::capacity_by_order |
The capacity of the parameters and raw_bits arrays specified as an order, i.e. the number of array elements allocated is 2 ^ capacity_by_order.
◆ channel_assignment
| FLAC__ChannelAssignment FLAC__FrameHeader::channel_assignment |
The channel assignment for the frame.
◆ channels [1/2]
| unsigned FLAC__FrameHeader::channels |
The number of channels (== number of subframes).
◆ channels [2/2]
| unsigned FLAC__StreamMetadata_StreamInfo::channels |
◆ colors
| FLAC__uint32 FLAC__StreamMetadata_Picture::colors |
For indexed palettes (like GIF), picture's number of colors (the number of palette entries), or 0 for non-indexed (i.e. 2^depth).
◆ comments
| FLAC__StreamMetadata_VorbisComment_Entry* FLAC__StreamMetadata_VorbisComment::comments |
◆ [] [1/2]
| FLAC__Subframe_Constant { ... } ::constant |
◆ constant [2/2]
| FLAC__Subframe_Constant FLAC__Subframe::constant |
◆ contents
| const FLAC__EntropyCodingMethod_PartitionedRiceContents* FLAC__EntropyCodingMethod_PartitionedRice::contents |
The context's Rice parameters and/or raw bits.
◆ crc [1/2]
| FLAC__uint16 FLAC__FrameFooter::crc |
CRC-16 (polynomial = x^16 + x^15 + x^2 + x^0, initialized with 0) of the bytes before the crc, back to and including the frame header sync code.
◆ crc [2/2]
| FLAC__uint8 FLAC__FrameHeader::crc |
CRC-8 (polynomial = x^8 + x^2 + x^1 + x^0, initialized with 0) of the raw frame header bytes, meaning everything before the CRC byte including the sync code.
◆ [] [1/2]
| FLAC__StreamMetadata_CueSheet { ... } ::cue_sheet |
◆ cue_sheet [2/2]
| FLAC__StreamMetadata_CueSheet FLAC__StreamMetadata::cue_sheet |
◆ [union] [1/7]
| union { ... } FLAC__EntropyCodingMethod::data |
◆ [union] [2/7]
| union { ... } FLAC__StreamMetadata::data |
Polymorphic block data; use the type value to determine which to use.
◆ data [3/7]
| FLAC__byte* FLAC__StreamMetadata_Application::data |
◆ data [4/7]
| FLAC__byte* FLAC__StreamMetadata_Picture::data |
Binary picture data.
◆ data [5/7]
| FLAC__byte* FLAC__StreamMetadata_Unknown::data |
◆ [union] [6/7]
| union { ... } FLAC__Subframe::data |
◆ data [7/7]
| const FLAC__int32* FLAC__Subframe_Verbatim::data |
A pointer to verbatim signal.
◆ data_length
| FLAC__uint32 FLAC__StreamMetadata_Picture::data_length |
Length of binary picture data in bytes.
◆ depth
| FLAC__uint32 FLAC__StreamMetadata_Picture::depth |
Picture's color depth in bits-per-pixel.
◆ description
| FLAC__byte* FLAC__StreamMetadata_Picture::description |
Picture's description in UTF-8, NUL terminated. In file storage, the description is stored as a 32-bit length followed by the UTF-8 string with no NUL terminator, but is converted to a plain C string in this structure for convenience.
◆ dummy
| int FLAC__StreamMetadata_Padding::dummy |
Conceptually this is an empty struct since we don't store the padding bytes. Empty structs are not allowed by some C compilers, hence the dummy.
◆ entropy_coding_method [1/2]
| FLAC__EntropyCodingMethod FLAC__Subframe_Fixed::entropy_coding_method |
The residual coding method.
◆ entropy_coding_method [2/2]
| FLAC__EntropyCodingMethod FLAC__Subframe_LPC::entropy_coding_method |
The residual coding method.
◆ entry
| FLAC__byte* FLAC__StreamMetadata_VorbisComment_Entry::entry |
◆ [] [1/2]
| FLAC__Subframe_Fixed { ... } ::fixed |
◆ fixed [2/2]
| FLAC__Subframe_Fixed FLAC__Subframe::fixed |
◆ FLAC__ChannelAssignmentString
Maps a FLAC__ChannelAssignment to a C string.
Using a FLAC__ChannelAssignment as the index to this array will give the string equivalent. The contents should not be modified.
◆ FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_ESCAPE_PARAMETER
== (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_PARAMETER_LEN)-1
◆ FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_PARAMETER_LEN
== 5 (bits)
◆ FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER
== (1<<FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN)-1
◆ FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN
◆ FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN
== 4 (bits)
◆ FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN
◆ FLAC__ENTROPY_CODING_METHOD_TYPE_LEN
◆ FLAC__EntropyCodingMethodTypeString
Maps a FLAC__EntropyCodingMethodType to a C string.
Using a FLAC__EntropyCodingMethodType as the index to this array will give the string equivalent. The contents should not be modified.
◆ FLAC__FRAME_FOOTER_CRC_LEN
◆ FLAC__FRAME_HEADER_BITS_PER_SAMPLE_LEN
◆ FLAC__FRAME_HEADER_BLOCK_SIZE_LEN
◆ FLAC__FRAME_HEADER_BLOCKING_STRATEGY_LEN
◆ FLAC__FRAME_HEADER_CHANNEL_ASSIGNMENT_LEN
◆ FLAC__FRAME_HEADER_CRC_LEN
◆ FLAC__FRAME_HEADER_RESERVED_LEN
◆ FLAC__FRAME_HEADER_SAMPLE_RATE_LEN
◆ FLAC__FRAME_HEADER_SYNC
◆ FLAC__FRAME_HEADER_SYNC_LEN
◆ FLAC__FRAME_HEADER_ZERO_PAD_LEN
◆ FLAC__FrameNumberTypeString
Maps a FLAC__FrameNumberType to a C string.
Using a FLAC__FrameNumberType as the index to this array will give the string equivalent. The contents should not be modified.
◆ FLAC__MetadataTypeString
Maps a FLAC__MetadataType to a C string.
Using a FLAC__MetadataType as the index to this array will give the string equivalent. The contents should not be modified.
◆ FLAC__STREAM_METADATA_APPLICATION_ID_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN
== 128*8 (bits)
◆ FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN
◆ FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN
◆ FLAC__STREAM_METADATA_IS_LAST_LEN
◆ FLAC__STREAM_METADATA_LENGTH_LEN
◆ FLAC__STREAM_METADATA_PICTURE_COLORS_LEN
◆ FLAC__STREAM_METADATA_PICTURE_DATA_LENGTH_LEN
◆ FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN
◆ FLAC__STREAM_METADATA_PICTURE_DESCRIPTION_LENGTH_LEN
◆ FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN
◆ FLAC__STREAM_METADATA_PICTURE_MIME_TYPE_LENGTH_LEN
◆ FLAC__STREAM_METADATA_PICTURE_TYPE_LEN
◆ FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN
◆ FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN
◆ FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER
|
extern |
The value used in the sample_number field of FLAC__StreamMetadataSeekPoint used to indicate a placeholder point (== 0xffffffffffffffff).
◆ FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN
◆ FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN
◆ FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN
◆ FLAC__STREAM_METADATA_TYPE_LEN
◆ FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN
◆ FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN
◆ FLAC__STREAM_SYNC
The 32-bit integer big-endian representation of the beginning of a FLAC stream.
◆ FLAC__STREAM_SYNC_LEN
◆ FLAC__STREAM_SYNC_STRING
|
extern |
The byte string representation of the beginning of a FLAC stream.
◆ FLAC__StreamMetadata_Picture_TypeString
Maps a FLAC__StreamMetadata_Picture_Type to a C string.
Using a FLAC__StreamMetadata_Picture_Type as the index to this array will give the string equivalent. The contents should not be modified.
◆ FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN
◆ FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN
◆ FLAC__SUBFRAME_TYPE_CONSTANT_BYTE_ALIGNED_MASK
◆ FLAC__SUBFRAME_TYPE_FIXED_BYTE_ALIGNED_MASK
◆ FLAC__SUBFRAME_TYPE_LEN
◆ FLAC__SUBFRAME_TYPE_LPC_BYTE_ALIGNED_MASK
◆ FLAC__SUBFRAME_TYPE_VERBATIM_BYTE_ALIGNED_MASK
◆ FLAC__SUBFRAME_WASTED_BITS_FLAG_LEN
◆ FLAC__SUBFRAME_ZERO_PAD_LEN
== 1 (bit)
This used to be a zero-padding bit (hence the name FLAC__SUBFRAME_ZERO_PAD_LEN) but is now a reserved bit. It still has a mandatory value of 0 but in the future may take on the value 0 or 1 to mean something else.
◆ FLAC__SubframeTypeString
Maps a FLAC__SubframeType to a C string.
Using a FLAC__SubframeType as the index to this array will give the string equivalent. The contents should not be modified.
◆ FLAC__VENDOR_STRING
The vendor string inserted by the encoder into the VORBIS_COMMENT block. This is a NUL-terminated ASCII string; when inserted into the VORBIS_COMMENT the trailing null is stripped.
◆ FLAC__VERSION_STRING
The version string of the release, stamped onto the libraries and binaries.
- Note
- This does not correspond to the shared library version number, which is used to determine binary compatibility.
◆ footer
| FLAC__FrameFooter FLAC__Frame::footer |
◆ [] [1/2]
| FLAC__uint32 { ... } ::frame_number |
◆ frame_number [2/2]
| FLAC__uint32 FLAC__FrameHeader::frame_number |
◆ frame_samples
| unsigned FLAC__StreamMetadata_SeekPoint::frame_samples |
The number of samples in the target frame.
◆ header
| FLAC__FrameHeader FLAC__Frame::header |
◆ height
| FLAC__uint32 FLAC__StreamMetadata_Picture::height |
Picture's height in pixels.
◆ id
| FLAC__byte FLAC__StreamMetadata_Application::id[4] |
◆ indices
| FLAC__StreamMetadata_CueSheet_Index* FLAC__StreamMetadata_CueSheet_Track::indices |
NULL if num_indices == 0, else pointer to array of index points.
◆ is_cd
| FLAC__bool FLAC__StreamMetadata_CueSheet::is_cd |
true if CUESHEET corresponds to a Compact Disc, else false.
◆ is_last
| FLAC__bool FLAC__StreamMetadata::is_last |
true if this metadata block is the last, else false
◆ isrc
| char FLAC__StreamMetadata_CueSheet_Track::isrc[13] |
Track ISRC. This is a 12-digit alphanumeric code plus a trailing NUL byte
◆ lead_in
| FLAC__uint64 FLAC__StreamMetadata_CueSheet::lead_in |
The number of lead-in samples.
◆ length [1/2]
| unsigned FLAC__StreamMetadata::length |
Length, in bytes, of the block data as it appears in the stream.
◆ length [2/2]
| FLAC__uint32 FLAC__StreamMetadata_VorbisComment_Entry::length |
◆ [] [1/2]
| FLAC__Subframe_LPC { ... } ::lpc |
◆ lpc [2/2]
| FLAC__Subframe_LPC FLAC__Subframe::lpc |
◆ max_blocksize
| unsigned FLAC__StreamMetadata_StreamInfo::max_blocksize |
◆ max_framesize
| unsigned FLAC__StreamMetadata_StreamInfo::max_framesize |
◆ md5sum
| FLAC__byte FLAC__StreamMetadata_StreamInfo::md5sum[16] |
◆ media_catalog_number
| char FLAC__StreamMetadata_CueSheet::media_catalog_number[129] |
Media catalog number, in ASCII printable characters 0x20-0x7e. In general, the media catalog number may be 0 to 128 bytes long; any unused characters should be right-padded with NUL characters.
◆ mime_type
| char* FLAC__StreamMetadata_Picture::mime_type |
Picture data's MIME type, in ASCII printable characters 0x20-0x7e, NUL terminated. For best compatibility with players, use picture data of MIME type image/jpeg or image/png. A MIME type of '-->' is also allowed, in which case the picture data should be a complete URL. In file storage, the MIME type is stored as a 32-bit length followed by the ASCII string with no NUL terminator, but is converted to a plain C string in this structure for convenience.
◆ min_blocksize
| unsigned FLAC__StreamMetadata_StreamInfo::min_blocksize |
◆ min_framesize
| unsigned FLAC__StreamMetadata_StreamInfo::min_framesize |
◆ num_comments
| FLAC__uint32 FLAC__StreamMetadata_VorbisComment::num_comments |
◆ num_indices
| FLAC__byte FLAC__StreamMetadata_CueSheet_Track::num_indices |
The number of track index points.
◆ num_points
| unsigned FLAC__StreamMetadata_SeekTable::num_points |
◆ num_tracks
| unsigned FLAC__StreamMetadata_CueSheet::num_tracks |
The number of tracks.
◆ [union] [1/3]
| union { ... } FLAC__FrameHeader::number |
The frame number or sample number of first sample in frame; use the number_type value to determine which to use.
◆ number [2/3]
| FLAC__byte FLAC__StreamMetadata_CueSheet_Index::number |
The index point number.
◆ number [3/3]
| FLAC__byte FLAC__StreamMetadata_CueSheet_Track::number |
The track number.
◆ number_type
| FLAC__FrameNumberType FLAC__FrameHeader::number_type |
The numbering scheme used for the frame. As a convenience, the decoder will always convert a frame number to a sample number because the rules are complex.
◆ offset [1/2]
| FLAC__uint64 FLAC__StreamMetadata_CueSheet_Index::offset |
Offset in samples, relative to the track offset, of the index point.
◆ offset [2/2]
| FLAC__uint64 FLAC__StreamMetadata_CueSheet_Track::offset |
Track offset in samples, relative to the beginning of the FLAC audio stream.
◆ order [1/3]
| unsigned FLAC__EntropyCodingMethod_PartitionedRice::order |
The partition order, i.e. # of contexts = 2 ^ order.
◆ order [2/3]
| unsigned FLAC__Subframe_Fixed::order |
The polynomial order.
◆ order [3/3]
| unsigned FLAC__Subframe_LPC::order |
The FIR order.
◆ [] [1/2]
| FLAC__StreamMetadata_Padding { ... } ::padding |
◆ padding [2/2]
| FLAC__StreamMetadata_Padding FLAC__StreamMetadata::padding |
◆ parameters
| unsigned* FLAC__EntropyCodingMethod_PartitionedRiceContents::parameters |
The Rice parameters for each context.
◆ [] [1/2]
| FLAC__EntropyCodingMethod_PartitionedRice { ... } ::partitioned_rice |
◆ partitioned_rice [2/2]
| FLAC__EntropyCodingMethod_PartitionedRice FLAC__EntropyCodingMethod::partitioned_rice |
◆ [] [1/2]
| FLAC__StreamMetadata_Picture { ... } ::picture |
◆ picture [2/2]
| FLAC__StreamMetadata_Picture FLAC__StreamMetadata::picture |
◆ points
| FLAC__StreamMetadata_SeekPoint* FLAC__StreamMetadata_SeekTable::points |
◆ pre_emphasis
| unsigned FLAC__StreamMetadata_CueSheet_Track::pre_emphasis |
The pre-emphasis flag: 0 for no pre-emphasis, 1 for pre-emphasis.
◆ qlp_coeff
| FLAC__int32 FLAC__Subframe_LPC::qlp_coeff[FLAC__MAX_LPC_ORDER] |
FIR filter coefficients.
◆ qlp_coeff_precision
| unsigned FLAC__Subframe_LPC::qlp_coeff_precision |
Quantized FIR filter coefficient precision in bits.
◆ quantization_level
| int FLAC__Subframe_LPC::quantization_level |
The qlp coeff shift needed.
◆ raw_bits
| unsigned* FLAC__EntropyCodingMethod_PartitionedRiceContents::raw_bits |
Widths for escape-coded partitions. Will be non-zero for escaped partitions and zero for unescaped partitions.
◆ residual [1/2]
| const FLAC__int32* FLAC__Subframe_Fixed::residual |
The residual signal, length == (blocksize minus order) samples.
◆ residual [2/2]
| const FLAC__int32* FLAC__Subframe_LPC::residual |
The residual signal, length == (blocksize minus order) samples.
◆ [] [1/3]
| FLAC__uint64 { ... } ::sample_number |
◆ sample_number [2/3]
| FLAC__uint64 FLAC__FrameHeader::sample_number |
◆ sample_number [3/3]
| FLAC__uint64 FLAC__StreamMetadata_SeekPoint::sample_number |
The sample number of the target frame.
◆ sample_rate [1/2]
| unsigned FLAC__FrameHeader::sample_rate |
The sample rate in Hz.
◆ sample_rate [2/2]
| unsigned FLAC__StreamMetadata_StreamInfo::sample_rate |
◆ [] [1/2]
| FLAC__StreamMetadata_SeekTable { ... } ::seek_table |
◆ seek_table [2/2]
| FLAC__StreamMetadata_SeekTable FLAC__StreamMetadata::seek_table |
◆ [] [1/2]
| FLAC__StreamMetadata_StreamInfo { ... } ::stream_info |
◆ stream_info [2/2]
| FLAC__StreamMetadata_StreamInfo FLAC__StreamMetadata::stream_info |
◆ stream_offset
| FLAC__uint64 FLAC__StreamMetadata_SeekPoint::stream_offset |
The offset, in bytes, of the target frame with respect to beginning of the first frame.
◆ subframes
| FLAC__Subframe FLAC__Frame::subframes[FLAC__MAX_CHANNELS] |
◆ total_samples
| FLAC__uint64 FLAC__StreamMetadata_StreamInfo::total_samples |
◆ tracks
| FLAC__StreamMetadata_CueSheet_Track* FLAC__StreamMetadata_CueSheet::tracks |
NULL if num_tracks == 0, else pointer to array of tracks.
◆ type [1/5]
| FLAC__EntropyCodingMethodType FLAC__EntropyCodingMethod::type |
◆ type [2/5]
| FLAC__MetadataType FLAC__StreamMetadata::type |
The type of the metadata block; used determine which member of the data union to dereference. If type >= FLAC__METADATA_TYPE_UNDEFINED then data.unknown must be used.
◆ type [3/5]
| unsigned FLAC__StreamMetadata_CueSheet_Track::type |
The track type: 0 for audio, 1 for non-audio.
◆ type [4/5]
| FLAC__StreamMetadata_Picture_Type FLAC__StreamMetadata_Picture::type |
The kind of picture stored.
◆ type [5/5]
| FLAC__SubframeType FLAC__Subframe::type |
◆ [] [1/2]
| FLAC__StreamMetadata_Unknown { ... } ::unknown |
◆ unknown [2/2]
| FLAC__StreamMetadata_Unknown FLAC__StreamMetadata::unknown |
◆ value
| FLAC__int32 FLAC__Subframe_Constant::value |
The constant signal value.
◆ vendor_string
| FLAC__StreamMetadata_VorbisComment_Entry FLAC__StreamMetadata_VorbisComment::vendor_string |
◆ [] [1/2]
| FLAC__Subframe_Verbatim { ... } ::verbatim |
◆ verbatim [2/2]
| FLAC__Subframe_Verbatim FLAC__Subframe::verbatim |
◆ [] [1/2]
| FLAC__StreamMetadata_VorbisComment { ... } ::vorbis_comment |
◆ vorbis_comment [2/2]
| FLAC__StreamMetadata_VorbisComment FLAC__StreamMetadata::vorbis_comment |
◆ warmup [1/2]
| FLAC__int32 FLAC__Subframe_Fixed::warmup[FLAC__MAX_FIXED_ORDER] |
Warmup samples to prime the predictor, length == order.
◆ warmup [2/2]
| FLAC__int32 FLAC__Subframe_LPC::warmup[FLAC__MAX_LPC_ORDER] |
Warmup samples to prime the predictor, length == order.
◆ wasted_bits
| unsigned FLAC__Subframe::wasted_bits |
◆ width
| FLAC__uint32 FLAC__StreamMetadata_Picture::width |
Picture's width in pixels.
Generated on for LMMS by
1.16.1