Statistics
| Branch: | Revision:

ffmpeg / libavformat / vorbiscomment.h @ 66061a12

History | View | Annotate | Download (2.15 KB)

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
 * Calculates 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
 * @param count Pointer to store the number of tags in m because m->count is "not allowed"
36
 * @return The length in bytes.
37
 */
38
int ff_vorbiscomment_length(AVMetadata *m, const char *vendor_string,
39
                            unsigned *count);
40

    
41
/**
42
 * Writes a VorbisComment into a buffer. The buffer, p, must have enough
43
 * data to hold the whole VorbisComment. The minimum size required can be
44
 * obtained by passing the same AVMetadata and vendor_string to
45
 * ff_vorbiscomment_length()
46
 *
47
 * @param p The buffer in which to write.
48
 * @param m The metadata struct to write.
49
 * @param vendor_string The vendor string to write.
50
 * @param count The number of tags in m because m->count is "not allowed"
51
 */
52
int ff_vorbiscomment_write(uint8_t **p, AVMetadata *m,
53
                           const char *vendor_string, const unsigned count);
54

    
55
extern const AVMetadataConv ff_vorbiscomment_metadata_conv[];
56

    
57
#endif /* AVFORMAT_VORBISCOMMENT_H */