vorbiscomment.h 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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. #ifndef AVFORMAT_VORBISCOMMENT_H
  22. #define AVFORMAT_VORBISCOMMENT_H
  23. #include "avformat.h"
  24. #include "metadata.h"
  25. /**
  26. * Calculate the length in bytes of a VorbisComment. This is the minimum
  27. * size required by ff_vorbiscomment_write().
  28. *
  29. * @param m The metadata structure to be parsed. For no metadata, set to NULL.
  30. * @param vendor_string The vendor string to be added into the VorbisComment.
  31. * For no string, set to an empty string.
  32. * @param count Pointer to store the number of tags in m because m->count is "not allowed"
  33. * @return The length in bytes.
  34. */
  35. int ff_vorbiscomment_length(AVDictionary *m, const char *vendor_string,
  36. unsigned *count);
  37. /**
  38. * Writes a VorbisComment into a buffer. The buffer, p, must have enough
  39. * data to hold the whole VorbisComment. The minimum size required can be
  40. * obtained by passing the same AVDictionary and vendor_string to
  41. * ff_vorbiscomment_length()
  42. *
  43. * @param p The buffer in which to write.
  44. * @param m The metadata struct to write.
  45. * @param vendor_string The vendor string to write.
  46. * @param count The number of tags in m because m->count is "not allowed"
  47. */
  48. int ff_vorbiscomment_write(uint8_t **p, AVDictionary **m,
  49. const char *vendor_string, const unsigned count);
  50. extern const AVMetadataConv ff_vorbiscomment_metadata_conv[];
  51. #endif /* AVFORMAT_VORBISCOMMENT_H */