FFmpeg
4.0
libavformat
vorbiscomment.h
Go to the documentation of this file.
1
/*
2
* VorbisComment writer
3
* Copyright (c) 2009 James Darnley
4
*
5
* This file is part of FFmpeg.
6
*
7
* FFmpeg is free software; you can redistribute it and/or
8
* modify it under the terms of the GNU Lesser General Public
9
* License as published by the Free Software Foundation; either
10
* version 2.1 of the License, or (at your option) any later version.
11
*
12
* FFmpeg is distributed in the hope that it will be useful,
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
* Lesser General Public License for more details.
16
*
17
* You should have received a copy of the GNU Lesser General Public
18
* License along with FFmpeg; if not, write to the Free Software
19
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
*/
21
22
#ifndef AVFORMAT_VORBISCOMMENT_H
23
#define AVFORMAT_VORBISCOMMENT_H
24
25
#include "
avformat.h
"
26
#include "
metadata.h
"
27
28
/**
29
* Calculate the length in bytes of a VorbisComment. This is the minimum
30
* size required by ff_vorbiscomment_write().
31
*
32
* @param m The metadata structure to be parsed. For no metadata, set to NULL.
33
* @param vendor_string The vendor string to be added into the VorbisComment.
34
* For no string, set to an empty string.
35
* @return The length in bytes.
36
*/
37
int64_t
ff_vorbiscomment_length
(
AVDictionary
*m,
const
char
*vendor_string);
38
39
/**
40
* Write a VorbisComment into a buffer. The buffer, p, must have enough
41
* data to hold the whole VorbisComment. The minimum size required can be
42
* obtained by passing the same AVDictionary and vendor_string to
43
* ff_vorbiscomment_length()
44
*
45
* @param p The buffer in which to write.
46
* @param m The metadata struct to write.
47
* @param vendor_string The vendor string to write.
48
*/
49
int
ff_vorbiscomment_write
(
uint8_t
**p,
AVDictionary
**m,
50
const
char
*vendor_string);
51
52
extern
const
AVMetadataConv
ff_vorbiscomment_metadata_conv
[];
53
54
#endif
/* AVFORMAT_VORBISCOMMENT_H */
metadata.h
internal metadata API header see avformat.h or the public API!
uint8_t
uint8_t
Definition:
audio_convert.c:194
ff_vorbiscomment_write
int ff_vorbiscomment_write(uint8_t **p, AVDictionary **m, const char *vendor_string)
Write a VorbisComment into a buffer.
Definition:
vorbiscomment.c:54
AVMetadataConv
Definition:
metadata.h:34
AVDictionary
Definition:
dict.c:30
ff_vorbiscomment_length
int64_t ff_vorbiscomment_length(AVDictionary *m, const char *vendor_string)
Calculate the length in bytes of a VorbisComment.
Definition:
vorbiscomment.c:41
ff_vorbiscomment_metadata_conv
const AVMetadataConv ff_vorbiscomment_metadata_conv[]
VorbisComment metadata conversion mapping.
Definition:
vorbiscomment.c:33
avformat.h
Main libavformat public API header.
Generated on Tue May 22 2018 07:06:58 for FFmpeg by
1.8.13