claunia/flac
1
0
Fork 0
mirror of https://github.com/claunia/flac.git synced 2025-12-16 18:54:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

add FLAC__metadata_get_tags(), FLAC::Metadata::get_tags()

Browse Source
This commit is contained in:
Josh Coalson
2004-07-30 01:54:29 +00:00
parent 9645dddaad
commit 1aca6b114b
7 changed files with 164 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
include/FLAC++/metadata.h
View File

@@ -787,7 +787,7 @@ namespace FLAC {
* \ingroup flacpp_metadata
*
* \brief
* Level 0 metadata iterator.
* Level 0 metadata iterators.
*
* See the \link flac_metadata_level0 C layer equivalent \endlink
* for more.
@@ -797,6 +797,9 @@ namespace FLAC {
//! See FLAC__metadata_get_streaminfo().
FLACPP_API bool get_streaminfo(const char *filename, StreamInfo &streaminfo);
//
//! See FLAC__metadata_get_tags().
FLACPP_API bool get_tags(const char *filename, VorbisComment *&tags);
/* \} */

33
include/FLAC/metadata.h
View File

@@ -64,7 +64,7 @@
* There are three metadata interfaces of increasing complexity:
*
* Level 0:
* Read-only access to the STREAMINFO block.
* Read-only access to the STREAMINFO and VORBIS_COMMENT blocks.
*
* Level 1:
* Read-write access to all metadata blocks. This level is write-
@@ -123,8 +123,8 @@ extern "C" {
* \ingroup flac_metadata
*
* \brief
* The level 0 interface consists of a single routine to read the
* STREAMINFO block.
* The level 0 interface consists of individual routines to read the
* STREAMINFO and VORBIS_COMMENT blocks, requiring only a filename.
*
* It skips any ID3v2 tag at the head of the file.
*
@@ -135,17 +135,40 @@ extern "C" {
* will skip any ID3v2 tag at the head of the file.
*
* \param filename The path to the FLAC file to read.
* \param streaminfo A pointer to space for the STREAMINFO block.
* \param streaminfo A pointer to space for the STREAMINFO block. Since
* FLAC__StreamMetadata is a simple structure with no
* memory allocation involved, you pass the address of
* an existing structure. It need not be initialized.
* \assert
* \code filename != NULL \endcode
* \code streaminfo != NULL \endcode
* \retval FLAC__bool
* \c true if a valid STREAMINFO block was read from \a filename. Returns
* \c false if there was a memory allocation error, a file decoder error,
* or the file contained no STREAMINFO block.
* or the file contained no STREAMINFO block. (A memory allocation error
* is possible because this function must set up a file decoder.)
*/
FLAC_API FLAC__bool FLAC__metadata_get_streaminfo(const char *filename, FLAC__StreamMetadata *streaminfo);
/** Read the VORBIS_COMMENT metadata block of the given FLAC file. This
* function will skip any ID3v2 tag at the head of the file.
*
* \param filename The path to the FLAC file to read.
* \param tags The address where the returned pointer will be
* stored. The \a tags object must be deleted by
* the caller using FLAC__metadata_object_delete().
* \assert
* \code filename != NULL \endcode
* \code streaminfo != NULL \endcode
* \retval FLAC__bool
* \c true if a valid VORBIS_COMMENT block was read from \a filename,
* and \a *tags will be set to the address of the tag structure.
* Returns \c false if there was a memory allocation error, a file
* decoder error, or the file contained no VORBIS_COMMENT block, and
* \a *tags will be set to \c NULL.
*/
FLAC_API FLAC__bool FLAC__metadata_get_tags(const char *filename, FLAC__StreamMetadata **tags);
/* \} */