Chris@1: Chris@1: Chris@1: Chris@1: libvorbis - datatype - vorbis_comment Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

libvorbis documentation

libvorbis version 1.3.2 - 20101101

Chris@1: Chris@1:

vorbis_comment

Chris@1: Chris@1:

declared in "vorbis/codec.h"

Chris@1: Chris@1:

Chris@1: The vorbis_comment structure defines an Ogg Vorbis comment. Chris@1:

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

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

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

Parameters

Chris@1:
Chris@1:
user_comments
Chris@1:
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).
Chris@1:
comment_lengths
Chris@1:
An int array that stores the length of each comment string
Chris@1:
comments
Chris@1:
Int signifying number of user comments in user_comments field.
Chris@1:
vendor
Chris@1:
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.
Chris@1:
Chris@1: Chris@1: Chris@1:

Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

copyright © 2000-2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

Chris@1: Chris@1: Chris@1: Chris@1: