cannam@86: cannam@86: cannam@86: cannam@86: libvorbis - datatype - vorbis_comment cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libvorbis documentation

libvorbis version 1.3.2 - 20101101

cannam@86: cannam@86:

vorbis_comment

cannam@86: cannam@86:

declared in "vorbis/codec.h"

cannam@86: cannam@86:

cannam@86: The vorbis_comment structure defines an Ogg Vorbis comment. cannam@86:

cannam@86: Only the fields the program needs must be defined. If a field isn't cannam@86: defined by the application, it will either be blank (if it's a string value) cannam@86: or set to some reasonable default (usually 0). cannam@86:

cannam@86: Note: When encoding, while it is supported to modify a cannam@86: vorbis_comment structure directly, be sure to read the notes on the cannam@86: vorbis_comment_init and cannam@86: vorbis_comment_clear pages for cannam@86: considerations on memory allocation and freeing before you do so. Rule of cannam@86: thumb: call vorbis_comment_init, then either do all allocation, cannam@86: freeing, and modification yourself and do not call cannam@86: vorbis_comment_clear, or do all modification using libvorbis cannam@86: functions and do call vorbis_comment_clear. cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86: 
typedef struct vorbis_comment{
cannam@86:   /* unlimited user comment fields. */
cannam@86:   char **user_comments;
cannam@86:   int  *comment_lengths;
cannam@86:   int  comments;
cannam@86:   char *vendor;
cannam@86: 
cannam@86: } vorbis_comment;
cannam@86:
cannam@86: cannam@86:

Parameters

cannam@86:
cannam@86:
user_comments
cannam@86:
Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the comment_lengths array should be consulted to determine string length. For convenience, each string is also NULL-terminated by the decode library (although Vorbis comments are not NULL terminated within the bitstream itself).
cannam@86:
comment_lengths
cannam@86:
An int array that stores the length of each comment string
cannam@86:
comments
cannam@86:
Int signifying number of user comments in user_comments field.
cannam@86:
vendor
cannam@86:
Information about the Vorbis implementation that encoded the file. Stored in a standard C 0-terminated string. Libvorbis will fill this in itself when encoding a comment packet from this structure; when decoding, this contains the vendor string that was in the comment packet.
cannam@86:
cannam@86: cannam@86: cannam@86:

cannam@86:
cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

copyright © 2000-2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

cannam@86: cannam@86: cannam@86: cannam@86: