#include <mpg123.h>

Collaboration diagram for mpg123_id3v2:

[legend]

Public Attributes
unsigned char	version

mpg123_string *	title

mpg123_string *	artist

mpg123_string *	album

mpg123_string *	year

mpg123_string *	genre

mpg123_string *	comment

mpg123_text *	comment_list

size_t	comments

mpg123_text *	text

size_t	texts

mpg123_text *	extra

size_t	extras

mpg123_picture *	picture

size_t	pictures

Detailed Description

Data structure for storing IDV3v2 tags.

This structure is an attempt to aggregate the ID3v2 frames in an reasonably accessible manner.

The ID3v2 text frames are (often) allowed to contain multiple strings. So check for null bytes until you reach the mpg123_string fill. All text is encoded in UTF-8 and final string termination is ensured. URLs are suposed to contain only one string, but this data structure does not enforce that.

Since API_VERSION 50, you can expect URL frames folded into .text among the normal text fields and the user-defined URL frames into .extra, along with MCDI (.text) and UFID (.extra) as uppercase hex-encoded binary data.

Definition at line 2048 of file mpg123.h.

Member Data Documentation

◆ version

unsigned char mpg123_id3v2::version

3 or 4 for ID3v2.3 or ID3v2.4.

Definition at line 2050 of file mpg123.h.

◆ title

mpg123_string* mpg123_id3v2::title

Title string (pointer into text_list).

Definition at line 2051 of file mpg123.h.

◆ artist

mpg123_string* mpg123_id3v2::artist

Artist string (pointer into text_list).

Definition at line 2052 of file mpg123.h.

◆ album

mpg123_string* mpg123_id3v2::album

Album string (pointer into text_list).

Definition at line 2053 of file mpg123.h.

◆ year

mpg123_string* mpg123_id3v2::year

The year as a string (pointer into text_list).

Definition at line 2054 of file mpg123.h.

◆ genre

mpg123_string* mpg123_id3v2::genre

Genre String (pointer into text_list).

Definition at line 2055 of file mpg123.h.

◆ comment

mpg123_string* mpg123_id3v2::comment

Pointer to last encountered comment text with empty description. Encountered ID3v2 fields are appended to the following lists. There can be multiple occurences, the pointers above always point to the last encountered data.

Definition at line 2057 of file mpg123.h.

◆ comment_list

mpg123_text* mpg123_id3v2::comment_list

Array of comments.

Definition at line 2062 of file mpg123.h.

◆ comments

size_t mpg123_id3v2::comments

Number of comments.

Definition at line 2063 of file mpg123.h.

◆ text

mpg123_text* mpg123_id3v2::text

Array of ID3v2 text fields. This includes a number of T(ext) frames, but also USLT, MCDI, and URLs (IDs starting with W). Each ID occurs at most once. Descriptions and languages are empty.

Definition at line 2064 of file mpg123.h.

◆ texts

size_t mpg123_id3v2::texts

Numer of text fields.

Definition at line 2068 of file mpg123.h.

◆ extra

mpg123_text* mpg123_id3v2::extra

The array of extra text fields. This includes TXXX, WXXX and UFID. Same ID can appear multiple times with differing descriptions Also, UFID frames are hex-encoded and added here with owner as description.

Definition at line 2069 of file mpg123.h.

◆ extras

size_t mpg123_id3v2::extras

Number of extra text fields.

Definition at line 2073 of file mpg123.h.

◆ picture

mpg123_picture* mpg123_id3v2::picture

Array of ID3v2 pictures fields (APIC). Only populated if MPG123_PICTURE flag is set!

Definition at line 2074 of file mpg123.h.

◆ pictures

size_t mpg123_id3v2::pictures

Number of picture (APIC) fields.

Definition at line 2076 of file mpg123.h.

The documentation for this struct was generated from the following file:

mpg123.h

API documentation for libmpg123, libout123, and libsyn123

Public Attributes