Lines Matching refs:object
112 * directly is more complex. The metadata object routines here facilitate
165 * stored. The \a tags object must be deleted by
184 * stored. The \a cuesheet object must be deleted by
208 * stored. The \a picture object must be deleted by
262 * the current iterator position. The returned object is yours to modify
269 * Use the object creation functions from
366 /** Free an iterator instance. Deletes the object pointed to by \a iterator.
536 * You must call FLAC__metadata_object_delete() on the returned object
681 * FLAC__metadata_iterator_get_block(). The pointer to the object
800 /** Free a chain instance. Deletes the object pointed to by \a chain.
1092 /** Free an iterator instance. Deletes the object pointed to by \a iterator.
1159 * Do not call FLAC__metadata_object_delete() on the returned object;
1247 /** \defgroup flac_metadata_object FLAC/metadata.h: metadata object methods
1254 * management. We decree that all pointers to data in the object are
1255 * owned by the object and memory-managed by the object.
1261 * to \c false to give the object ownership of your data. In the latter case
1262 * your pointer must be freeable by free() and will be free()d when the object
1269 * object. The FLAC__metadata_object_set_*() functions return \c false in the
1297 /** Create a new metadata object instance of the given type.
1299 * The object will be "empty"; i.e. values and data pointers will be \c 0,
1307 * \param type Type of object to create
1314 /** Create a copy of an existing metadata object.
1317 * object is also copied. The caller takes ownership of the new block and
1320 * \param object Pointer to object to copy.
1322 * \code object != NULL \endcode
1326 FLAC_API FLAC__StreamMetadata *FLAC__metadata_object_clone(const FLAC__StreamMetadata *object);
1328 /** Free a metadata object. Deletes the object pointed to by \a object.
1331 * object is also deleted.
1333 * \param object A pointer to an existing object.
1335 * \code object != NULL \endcode
1337 FLAC_API void FLAC__metadata_object_delete(FLAC__StreamMetadata *object);
1342 * object is also compared.
1344 * \param block1 A pointer to an existing object.
1345 * \param block2 A pointer to an existing object.
1356 * If \a copy is \c true, a copy of the data is stored; otherwise, the object
1363 * \param object A pointer to an existing APPLICATION object.
1368 * \code object != NULL \endcode
1369 * \code object->type == FLAC__METADATA_TYPE_APPLICATION \endcode
1375 FLAC_API FLAC__bool FLAC__metadata_object_application_set_data(FLAC__StreamMetadata *object, FLAC__byte *data, unsigned length, FLAC__bool copy);
1382 * \param object A pointer to an existing SEEKTABLE object.
1385 * \code object != NULL \endcode
1386 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1387 * \code (object->data.seek_table.points == NULL && object->data.seek_table.num_points == 0) ||
1388 * (object->data.seek_table.points != NULL && object->data.seek_table.num_points > 0) \endcode
1392 FLAC_API FLAC__bool FLAC__metadata_object_seektable_resize_points(FLAC__StreamMetadata *object, unsigned new_num_points);
1396 * \param object A pointer to an existing SEEKTABLE object.
1400 * \code object != NULL \endcode
1401 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1402 * \code object->data.seek_table.num_points > point_num \endcode
1404 FLAC_API void FLAC__metadata_object_seektable_set_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1408 * \param object A pointer to an existing SEEKTABLE object.
1412 * \code object != NULL \endcode
1413 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1414 * \code object->data.seek_table.num_points >= point_num \endcode
1418 FLAC_API FLAC__bool FLAC__metadata_object_seektable_insert_point(FLAC__StreamMetadata *object, unsigned point_num, FLAC__StreamMetadata_SeekPoint point);
1422 * \param object A pointer to an existing SEEKTABLE object.
1425 * \code object != NULL \endcode
1426 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1427 * \code object->data.seek_table.num_points > point_num \endcode
1431 FLAC_API FLAC__bool FLAC__metadata_object_seektable_delete_point(FLAC__StreamMetadata *object, unsigned point_num);
1437 * \param object A pointer to an existing SEEKTABLE object.
1439 * \code object != NULL \endcode
1440 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1444 FLAC_API FLAC__bool FLAC__metadata_object_seektable_is_legal(const FLAC__StreamMetadata *object);
1453 * \param object A pointer to an existing SEEKTABLE object.
1456 * \code object != NULL \endcode
1457 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1461 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_placeholders(FLAC__StreamMetadata *object, unsigned num);
1470 * \param object A pointer to an existing SEEKTABLE object.
1473 * \code object != NULL \endcode
1474 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1478 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_point(FLAC__StreamMetadata *object, FLAC__uint64 sample_number);
1487 * \param object A pointer to an existing SEEKTABLE object.
1491 * \code object != NULL \endcode
1492 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1496 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_points(FLAC__StreamMetadata *object, FLAC__uint64 sample_numbers[], unsigned num);
1506 * \param object A pointer to an existing SEEKTABLE object.
1512 * \code object != NULL \endcode
1513 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1518 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_spaced_points(FLAC__StreamMetadata *object, unsigned num, FLAC__uint64 total_samples);
1528 * \param object A pointer to an existing SEEKTABLE object.
1539 * \code object != NULL \endcode
1540 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1546 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_append_spaced_points_by_samples(FLAC__StreamMetadata *object, unsigned samples, FLAC__uint64 total_samples);
1551 * \param object A pointer to a seek table to be sorted.
1558 * \code object != NULL \endcode
1559 * \code object->type == FLAC__METADATA_TYPE_SEEKTABLE \endcode
1563 FLAC_API FLAC__bool FLAC__metadata_object_seektable_template_sort(FLAC__StreamMetadata *object, FLAC__bool compact);
1570 * If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1576 * \param object A pointer to an existing VORBIS_COMMENT object.
1580 * \code object != NULL \endcode
1581 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1588 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_set_vendor_string(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1595 * \param object A pointer to an existing VORBIS_COMMENT object.
1598 * \code object != NULL \endcode
1599 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1600 * \code (object->data.vorbis_comment.comments == NULL && object->data.vorbis_comment.num_comments == 0) ||
1601 * (object->data.vorbis_comment.comments != NULL && object->data.vorbis_comment.num_comments > 0) \endcode
1605 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_resize_comments(FLAC__StreamMetadata *object, unsigned new_num_comments);
1612 * If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1618 * \param object A pointer to an existing VORBIS_COMMENT object.
1623 * \code object != NULL \endcode
1624 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1625 * \code comment_num < object->data.vorbis_comment.num_comments \endcode
1632 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_set_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1639 * If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1645 * \param object A pointer to an existing VORBIS_COMMENT object.
1649 * \c object->data.vorbis_comment.num_comments .
1653 * \code object != NULL \endcode
1654 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1655 * \code object->data.vorbis_comment.num_comments >= comment_num \endcode
1662 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_insert_comment(FLAC__StreamMetadata *object, unsigned comment_num, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1669 * If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1675 * \param object A pointer to an existing VORBIS_COMMENT object.
1679 * \code object != NULL \endcode
1680 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1687 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_append_comment(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool copy);
1698 * If \a copy is \c true, a copy of the entry is stored; otherwise, the object
1704 * \param object A pointer to an existing VORBIS_COMMENT object.
1714 * \code object != NULL \endcode
1715 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1722 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_replace_comment(FLAC__StreamMetadata *object, FLAC__StreamMetadata_VorbisComment_Entry entry, FLAC__bool all, FLAC__bool copy);
1726 * \param object A pointer to an existing VORBIS_COMMENT object.
1729 * \code object != NULL \endcode
1730 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1731 * \code object->data.vorbis_comment.num_comments > comment_num \endcode
1735 FLAC_API FLAC__bool FLAC__metadata_object_vorbiscomment_delete_comment(FLAC__StreamMetadata *object, unsigned comment_num);
1798 * \param object A pointer to an existing VORBIS_COMMENT object.
1803 * \code object != NULL \endcode
1804 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1810 FLAC_API int FLAC__metadata_object_vorbiscomment_find_entry_from(const FLAC__StreamMetadata *object, unsigned offset, const char *field_name);
1814 * \param object A pointer to an existing VORBIS_COMMENT object.
1817 * \code object != NULL \endcode
1818 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1823 FLAC_API int FLAC__metadata_object_vorbiscomment_remove_entry_matching(FLAC__StreamMetadata *object, const char *field_name);
1827 * \param objectobject.
1830 * \code object != NULL \endcode
1831 * \code object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT \endcode
1836 FLAC_API int FLAC__metadata_object_vorbiscomment_remove_entries_matching(FLAC__StreamMetadata *object, const char *field_name);
1840 * The object will be "empty"; i.e. values and data pointers will be \c 0.
1847 /** Create a copy of an existing CUESHEET track object.
1850 * object is also copied. The caller takes ownership of the new object and
1854 * \param object Pointer to object to copy.
1856 * \code object != NULL \endcode
1860 FLAC_API FLAC__StreamMetadata_CueSheet_Track *FLAC__metadata_object_cuesheet_track_clone(const FLAC__StreamMetadata_CueSheet_Track *object);
1862 /** Delete a CUESHEET track object
1864 * \param object A pointer to an existing CUESHEET track object.
1866 * \code object != NULL \endcode
1868 FLAC_API void FLAC__metadata_object_cuesheet_track_delete(FLAC__StreamMetadata_CueSheet_Track *object);
1875 * \param object A pointer to an existing CUESHEET object.
1880 * \code object != NULL \endcode
1881 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1882 * \code object->data.cue_sheet.num_tracks > track_num \endcode
1883 * \code (object->data.cue_sheet.tracks[track_num].indices == NULL && object->data.cue_sheet.tracks[track_num].num_indices == 0) ||
1884 * (object->data.cue_sheet.tracks[track_num].indices != NULL && object->data.cue_sheet.tracks[track_num].num_indices > 0) \endcode
1888 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_resize_indices(FLAC__StreamMetadata *object, unsigned track_num, unsigned new_num_indices);
1892 * \param object A pointer to an existing CUESHEET object.
1901 * \c object->data.cue_sheet.tracks[track_num].num_indices .
1904 * \code object != NULL \endcode
1905 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1906 * \code object->data.cue_sheet.num_tracks > track_num \endcode
1907 * \code object->data.cue_sheet.tracks[track_num].num_indices >= index_num \endcode
1911 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_insert_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num, FLAC__StreamMetadata_CueSheet_Index index);
1917 * \param object A pointer to an existing CUESHEET object.
1926 * \c object->data.cue_sheet.tracks[track_num].num_indices .
1928 * \code object != NULL \endcode
1929 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1930 * \code object->data.cue_sheet.num_tracks > track_num \endcode
1931 * \code object->data.cue_sheet.tracks[track_num].num_indices >= index_num \endcode
1935 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_insert_blank_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num);
1939 * \param object A pointer to an existing CUESHEET object.
1947 * \code object != NULL \endcode
1948 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1949 * \code object->data.cue_sheet.num_tracks > track_num \endcode
1950 * \code object->data.cue_sheet.tracks[track_num].num_indices > index_num \endcode
1954 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_track_delete_index(FLAC__StreamMetadata *object, unsigned track_num, unsigned index_num);
1961 * \param object A pointer to an existing CUESHEET object.
1964 * \code object != NULL \endcode
1965 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1966 * \code (object->data.cue_sheet.tracks == NULL && object->data.cue_sheet.num_tracks == 0) ||
1967 * (object->data.cue_sheet.tracks != NULL && object->data.cue_sheet.num_tracks > 0) \endcode
1971 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_resize_tracks(FLAC__StreamMetadata *object, unsigned new_num_tracks);
1975 * If \a copy is \c true, a copy of the track is stored; otherwise, the object
1978 * \param object A pointer to an existing CUESHEET object.
1985 * \code object != NULL \endcode
1986 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
1987 * \code track_num < object->data.cue_sheet.num_tracks \endcode
1993 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_set_track(FLAC__StreamMetadata *object, unsigned track_num, FLAC__StreamMetadata_CueSheet_Track *track, FLAC__bool copy);
1997 * If \a copy is \c true, a copy of the track is stored; otherwise, the object
2000 * \param object A pointer to an existing CUESHEET object.
2005 * \a track_num to \c object->data.cue_sheet.num_tracks .
2010 * \code object != NULL \endcode
2011 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
2012 * \code object->data.cue_sheet.num_tracks >= track_num \endcode
2016 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_insert_track(FLAC__StreamMetadata *object, unsigned track_num, FLAC__StreamMetadata_CueSheet_Track *track, FLAC__bool copy);
2022 * \param object A pointer to an existing CUESHEET object.
2027 * \a track_num to \c object->data.cue_sheet.num_tracks .
2029 * \code object != NULL \endcode
2030 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
2031 * \code object->data.cue_sheet.num_tracks >= track_num \endcode
2035 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_insert_blank_track(FLAC__StreamMetadata *object, unsigned track_num);
2039 * \param object A pointer to an existing CUESHEET object.
2044 * \code object != NULL \endcode
2045 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
2046 * \code object->data.cue_sheet.num_tracks > track_num \endcode
2050 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_delete_track(FLAC__StreamMetadata *object, unsigned track_num);
2056 * \param object A pointer to an existing CUESHEET object.
2066 * \code object != NULL \endcode
2067 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
2071 FLAC_API FLAC__bool FLAC__metadata_object_cuesheet_is_legal(const FLAC__StreamMetadata *object, FLAC__bool check_cd_da_subset, const char **violation);
2077 * \param object A pointer to an existing CUESHEET object.
2079 * \code object != NULL \endcode
2080 * \code object->type == FLAC__METADATA_TYPE_CUESHEET \endcode
2084 FLAC_API FLAC__uint32 FLAC__metadata_object_cuesheet_calculate_cddb_id(const FLAC__StreamMetadata *object);
2088 * If \a copy is \c true, a copy of the string is stored; otherwise, the object
2095 * \param object A pointer to an existing PICTURE object.
2101 * \code object != NULL \endcode
2102 * \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2107 FLAC_API FLAC__bool FLAC__metadata_object_picture_set_mime_type(FLAC__StreamMetadata *object, char *mime_type, FLAC__bool copy);
2111 * If \a copy is \c true, a copy of the string is stored; otherwise, the object
2118 * \param object A pointer to an existing PICTURE object.
2123 * \code object != NULL \endcode
2124 * \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2129 FLAC_API FLAC__bool FLAC__metadata_object_picture_set_description(FLAC__StreamMetadata *object, FLAC__byte *description, FLAC__bool copy);
2133 * If \a copy is \c true, a copy of the data is stored; otherwise, the object
2135 * metadata object to what is passed in as the \a length parameter. The
2142 * \param object A pointer to an existing PICTURE object.
2147 * \code object != NULL \endcode
2148 * \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2154 object, FLAC__byte *data, FLAC__uint32 length, FLAC__bool copy);
2160 * \param object A pointer to existing PICTURE block to be checked.
2168 * \code object != NULL \endcode
2169 * \code object->type == FLAC__METADATA_TYPE_PICTURE \endcode
2173 FLAC_API FLAC__bool FLAC__metadata_object_picture_is_legal(const FLAC__StreamMetadata *object, const char **violation);
