libavformat/vorbiscomment.h
66061a12
 /*
  * VorbisComment writer
  * Copyright (c) 2009 James Darnley
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef AVFORMAT_VORBISCOMMENT_H
 #define AVFORMAT_VORBISCOMMENT_H
 
 #include "avformat.h"
 #include "metadata.h"
 
 /**
49bd8e4b
  * Calculate the length in bytes of a VorbisComment. This is the minimum
66061a12
  * size required by ff_vorbiscomment_write().
  *
  * @param m The metadata structure to be parsed. For no metadata, set to NULL.
  * @param vendor_string The vendor string to be added into the VorbisComment.
  * For no string, set to an empty string.
  * @return The length in bytes.
  */
704d7c9f
 int64_t ff_vorbiscomment_length(const AVDictionary *m, const char *vendor_string,
c0fb6f96
                                 AVChapter **chapters, unsigned int nb_chapters);
66061a12
 
 /**
6397b4d6
  * Write a VorbisComment into an AVIOContext. The output size can be obtained
  * in advance by passing the same chapters, AVDictionary and vendor_string to
66061a12
  * ff_vorbiscomment_length()
  *
6397b4d6
  * @param pb The AVIOContext to write the output.
66061a12
  * @param m The metadata struct to write.
  * @param vendor_string The vendor string to write.
c0fb6f96
  * @param chapters The chapters to write.
  * @param nb_chapters The number of chapters to write.
66061a12
  */
6397b4d6
 int ff_vorbiscomment_write(AVIOContext *pb, const AVDictionary *m,
c0fb6f96
                            const char *vendor_string,
                            AVChapter **chapters, unsigned int nb_chapters);
66061a12
 
 extern const AVMetadataConv ff_vorbiscomment_metadata_conv[];
 
 #endif /* AVFORMAT_VORBISCOMMENT_H */