FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions | Variables
vorbiscomment.h File Reference
#include "avformat.h"
#include "metadata.h"

Go to the source code of this file.

Functions

int ff_vorbiscomment_length (AVDictionary *m, const char *vendor_string, unsigned *count)
 Calculate the length in bytes of a VorbisComment.
 
int ff_vorbiscomment_write (uint8_t **p, AVDictionary **m, const char *vendor_string, const unsigned count)
 Write a VorbisComment into a buffer.
 

Variables

const AVMetadataConv ff_vorbiscomment_metadata_conv []
 VorbisComment metadata conversion mapping.
 

Function Documentation

int ff_vorbiscomment_length ( AVDictionary m,
const char *  vendor_string,
unsigned *  count 
)

Calculate the length in bytes of a VorbisComment.

This is the minimum size required by ff_vorbiscomment_write().

Parameters
mThe metadata structure to be parsed. For no metadata, set to NULL.
vendor_stringThe vendor string to be added into the VorbisComment. For no string, set to an empty string.
countPointer to store the number of tags in m because m->count is "not allowed"
Returns
The length in bytes.

Definition at line 40 of file vorbiscomment.c.

Referenced by flac_write_block_comment(), and ogg_write_vorbiscomment().

int ff_vorbiscomment_write ( uint8_t **  p,
AVDictionary **  m,
const char *  vendor_string,
const unsigned  count 
)

Write a VorbisComment into a buffer.

The buffer, p, must have enough data to hold the whole VorbisComment. The minimum size required can be obtained by passing the same AVDictionary and vendor_string to ff_vorbiscomment_length()

Parameters
pThe buffer in which to write.
mThe metadata struct to write.
vendor_stringThe vendor string to write.
countThe number of tags in m because m->count is "not allowed"

Definition at line 56 of file vorbiscomment.c.

Referenced by flac_write_block_comment(), and ogg_write_vorbiscomment().

Variable Documentation

const AVMetadataConv ff_vorbiscomment_metadata_conv[]

VorbisComment metadata conversion mapping.

from Ogg Vorbis I format specification: comment field and header specification http://xiph.org/vorbis/doc/v-comment.html

Definition at line 33 of file vorbiscomment.c.

Referenced by ff_vorbis_comment(), flac_write_block_comment(), and ogg_write_vorbiscomment().