Lines Matching full:metadata
46 /** \file include/FLAC/metadata.h
50 * metadata blocks in memory, and three progressively more powerful
51 * interfaces for traversing and editing metadata in FLAC files.
54 * \link flac_metadata metadata \endlink module.
57 /** \defgroup flac_metadata FLAC/metadata.h: metadata interfaces
62 * metadata blocks in memory, and three progressively more powerful
63 * interfaces for traversing and editing metadata in native FLAC files.
66 * metadata to file.
68 * There are three metadata interfaces of increasing complexity:
75 * Read-write access to all metadata blocks. This level is write-
80 * Read-write access to all metadata blocks. This level is write-
81 * efficient in all cases, but uses more memory since all metadata for
85 * What do we mean by efficient? Since FLAC metadata appears at the
86 * beginning of the file, when writing metadata back to a FLAC file
87 * it is possible to grow or shrink the metadata such that the entire
89 * changes or PADDING blocks are utilized, only the metadata needs to be
94 * cause more than one metadata block to grow or shrink beyond what can
96 * 2, which allows you to edit all the metadata for a file in memory and
108 * creating and manipulating various metadata objects in memory. As we see
109 * from the Format module, FLAC metadata blocks in memory are very primitive
112 * directly is more complex. The metadata object routines here facilitate
116 * metadata however, you will not probably not need these.
119 * the metadata module. This is so that embedded users can strip out the
120 * metadata module from libFLAC to reduce the size and complexity.
128 /** \defgroup flac_metadata_level0 FLAC/metadata.h: metadata level 0 interface
141 /** Read the STREAMINFO metadata block of the given FLAC file. This function
160 /** Read the VORBIS_COMMENT metadata block of the given FLAC file. This
172 * and \a *tags will be set to the address of the metadata structure.
179 /** Read the CUESHEET metadata block of the given FLAC file. This
191 * and \a *cuesheet will be set to the address of the metadata
198 /** Read a PICTURE metadata block of the given FLAC file. This
231 * and \a *picture will be set to the address of the metadata
241 /** \defgroup flac_metadata_level1 FLAC/metadata.h: metadata level 1 interface
245 * The level 1 interface provides read-write access to FLAC file metadata and
299 * \link flac_metadata_level1 metadata level 1 module \endlink
326 /**< The iterator encountered input that does not conform to the FLAC metadata specification */
386 /** Initialize the iterator to point to the first metadata block in the
419 /** Moves the iterator forward one metadata block, returning \c false if
428 * \c false if already at the last metadata block of the chain, else
433 /** Moves the iterator backward one metadata block, returning \c false if
442 * \c false if already at the first metadata block of the chain, else
447 /** Returns a flag telling if the current metadata block is the last.
455 * \c true if the current metadata block is the last in the file,
460 /** Get the offset of the metadata block at the current position. This
470 * The offset of the metadata block at the current iterator position.
472 * the current metadata block's header.
476 /** Get the type of the metadata block at the current position. This
486 * The type of the metadata block at the current iterator position.
490 /** Get the length of the metadata block at the current position. This
500 * The length of the metadata block at the current iterator position.
502 * <a href="http://flac.sourceforge.net/format.html#metadata_block_header">metadata block header</a>,
503 * i.e. the length of the metadata body that follows the header.
524 * current metadata block is not an \c APPLICATION block. Otherwise
532 /** Get the metadata block at the current position. You can modify the
545 * The current metadata block, or \c NULL if there was a memory
653 /** \defgroup flac_metadata_level2 FLAC/metadata.h: metadata level 2 interface
657 * The level 2 interface provides read-write access to FLAC file metadata;
658 * all metadata is read into memory, operated on in memory, and then written
668 * linked list of FLAC metadata blocks.
669 * - Read all metadata into the the chain from a FLAC file using
701 * The metadata objects returned by FLAC__metadata_iterator_get_block()
737 /**< The chain encountered input that does not conform to the FLAC metadata specification */
820 /** Read all metadata from a FLAC file into the chain.
828 * \c true if a valid list of metadata blocks was read from
834 /** Read all metadata from an Ogg FLAC file into the chain.
836 * \note Ogg FLAC metadata data writing is not supported yet and
845 * \c true if a valid list of metadata blocks was read from
851 /** Read all metadata from a FLAC stream into the chain via I/O callbacks.
859 * handle will NOT be closed after the metadata is read;
867 * \c true if a valid list of metadata blocks was read from
873 /** Read all metadata from an Ogg FLAC stream into the chain via I/O callbacks.
879 * \note Ogg FLAC metadata data writing is not supported yet and
884 * handle will NOT be closed after the metadata is read;
892 * \c true if a valid list of metadata blocks was read from
902 * edited metadata back to the FLAC file does not require rewriting the
904 * required. When writing metadata using callbacks, you must check
922 * \c false if metadata can be written in place.
926 /** Write all metadata out to the FLAC file. This function tries to be as
927 * efficient as possible; how the metadata is actually written is shown by
930 * If the current chain is the same size as the existing metadata, the new
933 * If the current chain is longer than the existing metadata, and
936 * so that the overall size of the metadata is the same as the existing
937 * metadata, and then just rewrite the metadata. Otherwise, if not all of
944 * If the current chain is shorter than the existing metadata, and
972 /** Write all metadata out to a FLAC stream via callbacks.
975 * used to write metadata in place if possible.)
990 * handle will NOT be closed after the metadata is
1002 /** Write all metadata out to a FLAC stream via callbacks.
1005 * used to write metadata in place if possible.)
1012 * FLAC file on top of the original FLAC file to complete the metadata
1034 * The handle will NOT be closed after the metadata is
1040 * handle will NOT be closed after the metadata is
1067 /** This function will move all PADDING blocks to the end on the metadata,
1100 /** Initialize the iterator to point to the first metadata block in the
1111 /** Moves the iterator forward one metadata block, returning \c false if
1120 * \c false if already at the last metadata block of the chain, else
1125 /** Moves the iterator backward one metadata block, returning \c false if
1134 * \c false if already at the first metadata block of the chain, else
1139 /** Get the type of the metadata block at the current position.
1147 * The type of the metadata block at the current iterator position.
1151 /** Get the metadata block at the current position. You can modify
1168 * The current metadata block.
1172 /** Set the metadata block at the current position, replacing the existing
1177 * \param block A pointer to a metadata block.
1215 * \param block A pointer to a metadata block to insert.
1233 * \param block A pointer to a metadata block to insert.
1247 /** \defgroup flac_metadata_object FLAC/metadata.h: metadata object methods
1251 * This module contains methods for manipulating FLAC metadata objects.
1289 * There is no need to recalculate the length field on metadata blocks you
1297 /** Create a new metadata object instance of the given type.
1314 /** Create a copy of an existing metadata object.
1328 /** Free a metadata object. Deletes the object pointed to by \a object.
1339 /** Compares two metadata objects.
2135 * metadata object to what is passed in as the \a length parameter. The
