1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2001,2002,2003,2004,2005,2006,2007 Josh Coalson
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * - Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * - Neither the name of the Xiph.org Foundation nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 #if defined _MSC_VER || defined __BORLANDC__ || defined __MINGW32__
42 #if defined __BORLANDC__
43 #include <utime.h> /* for utime() */
45 #include <sys/utime.h> /* for utime() */
47 #include <io.h> /* for chmod() */
48 #include <sys/types.h> /* for off_t */
49 #if _MSC_VER <= 1600 || defined __BORLANDC__ /* @@@ [2G limit] */
54 #include <sys/types.h> /* some flavors of BSD (like OS X) require this to get time_t */
55 #include <utime.h> /* for utime() */
56 #include <unistd.h> /* for chown(), unlink() */
58 #include <sys/stat.h> /* for stat(), maybe chmod() */
60 #include "private/metadata.h"
62 #include "FLAC/assert.h"
63 #include "FLAC/stream_decoder.h"
68 #define max(a,b) ((a)>(b)?(a):(b))
72 #define min(a,b) ((a)<(b)?(a):(b))
75 /****************************************************************************
77 * Local function declarations
79 ***************************************************************************/
81 static void pack_uint32_(FLAC__uint32 val, FLAC__byte *b, unsigned bytes);
82 static void pack_uint32_little_endian_(FLAC__uint32 val, FLAC__byte *b, unsigned bytes);
83 static void pack_uint64_(FLAC__uint64 val, FLAC__byte *b, unsigned bytes);
84 static FLAC__uint32 unpack_uint32_(FLAC__byte *b, unsigned bytes);
85 static FLAC__uint32 unpack_uint32_little_endian_(FLAC__byte *b, unsigned bytes);
86 static FLAC__uint64 unpack_uint64_(FLAC__byte *b, unsigned bytes);
88 static FLAC__bool read_metadata_block_header_(FLAC__Metadata_SimpleIterator *iterator);
89 static FLAC__bool read_metadata_block_data_(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block);
90 static FLAC__bool read_metadata_block_header_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__bool *is_last, FLAC__MetadataType *type, unsigned *length);
91 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Seek seek_cb, FLAC__StreamMetadata *block);
92 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_streaminfo_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_StreamInfo *block);
93 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_padding_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Seek seek_cb, FLAC__StreamMetadata_Padding *block, unsigned block_length);
94 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_application_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_Application *block, unsigned block_length);
95 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_seektable_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_SeekTable *block, unsigned block_length);
96 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_vorbis_comment_entry_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_VorbisComment_Entry *entry);
97 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_vorbis_comment_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_VorbisComment *block);
98 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_cuesheet_track_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_CueSheet_Track *track);
99 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_cuesheet_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_CueSheet *block);
100 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_picture_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_Picture *block);
101 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_unknown_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_Unknown *block, unsigned block_length);
103 static FLAC__bool write_metadata_block_header_(FILE *file, FLAC__Metadata_SimpleIteratorStatus *status, const FLAC__StreamMetadata *block);
104 static FLAC__bool write_metadata_block_data_(FILE *file, FLAC__Metadata_SimpleIteratorStatus *status, const FLAC__StreamMetadata *block);
105 static FLAC__bool write_metadata_block_header_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata *block);
106 static FLAC__bool write_metadata_block_data_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata *block);
107 static FLAC__bool write_metadata_block_data_streaminfo_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_StreamInfo *block);
108 static FLAC__bool write_metadata_block_data_padding_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Padding *block, unsigned block_length);
109 static FLAC__bool write_metadata_block_data_application_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Application *block, unsigned block_length);
110 static FLAC__bool write_metadata_block_data_seektable_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_SeekTable *block);
111 static FLAC__bool write_metadata_block_data_vorbis_comment_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_VorbisComment *block);
112 static FLAC__bool write_metadata_block_data_cuesheet_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_CueSheet *block);
113 static FLAC__bool write_metadata_block_data_picture_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Picture *block);
114 static FLAC__bool write_metadata_block_data_unknown_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Unknown *block, unsigned block_length);
116 static FLAC__bool write_metadata_block_stationary_(FLAC__Metadata_SimpleIterator *iterator, const FLAC__StreamMetadata *block);
117 static FLAC__bool write_metadata_block_stationary_with_padding_(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, unsigned padding_length, FLAC__bool padding_is_last);
118 static FLAC__bool rewrite_whole_file_(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool append);
120 static void simple_iterator_push_(FLAC__Metadata_SimpleIterator *iterator);
121 static FLAC__bool simple_iterator_pop_(FLAC__Metadata_SimpleIterator *iterator);
123 static unsigned seek_to_first_metadata_block_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Seek seek_cb);
124 static unsigned seek_to_first_metadata_block_(FILE *f);
126 static FLAC__bool simple_iterator_copy_file_prefix_(FLAC__Metadata_SimpleIterator *iterator, FILE **tempfile, char **tempfilename, FLAC__bool append);
127 static FLAC__bool simple_iterator_copy_file_postfix_(FLAC__Metadata_SimpleIterator *iterator, FILE **tempfile, char **tempfilename, int fixup_is_last_code, off_t fixup_is_last_flag_offset, FLAC__bool backup);
129 static FLAC__bool copy_n_bytes_from_file_(FILE *file, FILE *tempfile, off_t bytes, FLAC__Metadata_SimpleIteratorStatus *status);
130 static FLAC__bool copy_n_bytes_from_file_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOHandle temp_handle, FLAC__IOCallback_Write temp_write_cb, off_t bytes, FLAC__Metadata_SimpleIteratorStatus *status);
131 static FLAC__bool copy_remaining_bytes_from_file_(FILE *file, FILE *tempfile, FLAC__Metadata_SimpleIteratorStatus *status);
132 static FLAC__bool copy_remaining_bytes_from_file_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Eof eof_cb, FLAC__IOHandle temp_handle, FLAC__IOCallback_Write temp_write_cb, FLAC__Metadata_SimpleIteratorStatus *status);
134 static FLAC__bool open_tempfile_(const char *filename, const char *tempfile_path_prefix, FILE **tempfile, char **tempfilename, FLAC__Metadata_SimpleIteratorStatus *status);
135 static FLAC__bool transport_tempfile_(const char *filename, FILE **tempfile, char **tempfilename, FLAC__Metadata_SimpleIteratorStatus *status);
136 static void cleanup_tempfile_(FILE **tempfile, char **tempfilename);
138 static FLAC__bool get_file_stats_(const char *filename, struct stat *stats);
139 static void set_file_stats_(const char *filename, struct stat *stats);
141 static int fseek_wrapper_(FLAC__IOHandle handle, FLAC__int64 offset, int whence);
142 static FLAC__int64 ftell_wrapper_(FLAC__IOHandle handle);
144 static FLAC__Metadata_ChainStatus get_equivalent_status_(FLAC__Metadata_SimpleIteratorStatus status);
147 #ifdef FLAC__VALGRIND_TESTING
148 static size_t local__fwrite(const void *ptr, size_t size, size_t nmemb, FILE *stream)
150 size_t ret = fwrite(ptr, size, nmemb, stream);
156 #define local__fwrite fwrite
159 /****************************************************************************
161 * Level 0 implementation
163 ***************************************************************************/
165 static FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
166 static void metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
167 static void error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
170 FLAC__bool got_error;
171 FLAC__StreamMetadata *object;
172 } level0_client_data;
174 static FLAC__StreamMetadata *get_one_metadata_block_(const char *filename, FLAC__MetadataType type)
176 level0_client_data cd;
177 FLAC__StreamDecoder *decoder;
179 FLAC__ASSERT(0 != filename);
181 cd.got_error = false;
184 decoder = FLAC__stream_decoder_new();
189 FLAC__stream_decoder_set_md5_checking(decoder, false);
190 FLAC__stream_decoder_set_metadata_ignore_all(decoder);
191 FLAC__stream_decoder_set_metadata_respond(decoder, type);
193 if(FLAC__stream_decoder_init_file(decoder, filename, write_callback_, metadata_callback_, error_callback_, &cd) != FLAC__STREAM_DECODER_INIT_STATUS_OK || cd.got_error) {
194 (void)FLAC__stream_decoder_finish(decoder);
195 FLAC__stream_decoder_delete(decoder);
199 if(!FLAC__stream_decoder_process_until_end_of_metadata(decoder) || cd.got_error) {
200 (void)FLAC__stream_decoder_finish(decoder);
201 FLAC__stream_decoder_delete(decoder);
203 FLAC__metadata_object_delete(cd.object);
207 (void)FLAC__stream_decoder_finish(decoder);
208 FLAC__stream_decoder_delete(decoder);
213 FLAC_API FLAC__bool FLAC__metadata_get_streaminfo(const char *filename, FLAC__StreamMetadata *streaminfo)
215 FLAC__StreamMetadata *object;
217 FLAC__ASSERT(0 != filename);
218 FLAC__ASSERT(0 != streaminfo);
220 object = get_one_metadata_block_(filename, FLAC__METADATA_TYPE_STREAMINFO);
223 /* can just copy the contents since STREAMINFO has no internal structure */
224 *streaminfo = *object;
225 FLAC__metadata_object_delete(object);
233 FLAC_API FLAC__bool FLAC__metadata_get_tags(const char *filename, FLAC__StreamMetadata **tags)
235 FLAC__ASSERT(0 != filename);
236 FLAC__ASSERT(0 != tags);
238 *tags = get_one_metadata_block_(filename, FLAC__METADATA_TYPE_VORBIS_COMMENT);
243 FLAC_API FLAC__bool FLAC__metadata_get_cuesheet(const char *filename, FLAC__StreamMetadata **cuesheet)
245 FLAC__ASSERT(0 != filename);
246 FLAC__ASSERT(0 != cuesheet);
248 *cuesheet = get_one_metadata_block_(filename, FLAC__METADATA_TYPE_CUESHEET);
250 return 0 != *cuesheet;
253 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
255 (void)decoder, (void)frame, (void)buffer, (void)client_data;
257 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
260 void metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
262 level0_client_data *cd = (level0_client_data *)client_data;
266 * we assume we only get here when the one metadata block we were
267 * looking for was passed to us
269 if(!cd->got_error && 0 == cd->object) {
270 if(0 == (cd->object = FLAC__metadata_object_clone(metadata)))
271 cd->got_error = true;
275 void error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
277 level0_client_data *cd = (level0_client_data *)client_data;
280 if(status != FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC)
281 cd->got_error = true;
284 FLAC_API FLAC__bool FLAC__metadata_get_picture(const char *filename, FLAC__StreamMetadata **picture, FLAC__StreamMetadata_Picture_Type type, const char *mime_type, const FLAC__byte *description, unsigned max_width, unsigned max_height, unsigned max_depth, unsigned max_colors)
286 FLAC__Metadata_SimpleIterator *it;
287 FLAC__uint64 max_area_seen = 0;
288 FLAC__uint64 max_depth_seen = 0;
290 FLAC__ASSERT(0 != filename);
291 FLAC__ASSERT(0 != picture);
295 it = FLAC__metadata_simple_iterator_new();
298 if(!FLAC__metadata_simple_iterator_init(it, filename, /*read_only=*/true, /*preserve_file_stats=*/true)) {
299 FLAC__metadata_simple_iterator_delete(it);
303 if(FLAC__metadata_simple_iterator_get_block_type(it) == FLAC__METADATA_TYPE_PICTURE) {
304 FLAC__StreamMetadata *obj = FLAC__metadata_simple_iterator_get_block(it);
305 FLAC__uint64 area = (FLAC__uint64)obj->data.picture.width * (FLAC__uint64)obj->data.picture.height;
306 /* check constraints */
308 (type == (FLAC__StreamMetadata_Picture_Type)(-1) || type == obj->data.picture.type) &&
309 (mime_type == 0 || !strcmp(mime_type, obj->data.picture.mime_type)) &&
310 (description == 0 || !strcmp((const char *)description, (const char *)obj->data.picture.description)) &&
311 obj->data.picture.width <= max_width &&
312 obj->data.picture.height <= max_height &&
313 obj->data.picture.depth <= max_depth &&
314 obj->data.picture.colors <= max_colors &&
315 (area > max_area_seen || (area == max_area_seen && obj->data.picture.depth > max_depth_seen))
318 FLAC__metadata_object_delete(*picture);
320 max_area_seen = area;
321 max_depth_seen = obj->data.picture.depth;
324 FLAC__metadata_object_delete(obj);
327 } while(FLAC__metadata_simple_iterator_next(it));
329 FLAC__metadata_simple_iterator_delete(it);
331 return (0 != *picture);
335 /****************************************************************************
337 * Level 1 implementation
339 ***************************************************************************/
341 #define SIMPLE_ITERATOR_MAX_PUSH_DEPTH (1+4)
342 /* 1 for initial offset, +4 for our own personal use */
344 struct FLAC__Metadata_SimpleIterator {
346 char *filename, *tempfile_path_prefix;
348 FLAC__bool has_stats;
349 FLAC__bool is_writable;
350 FLAC__Metadata_SimpleIteratorStatus status;
351 off_t offset[SIMPLE_ITERATOR_MAX_PUSH_DEPTH];
352 off_t first_offset; /* this is the offset to the STREAMINFO block */
354 /* this is the metadata block header of the current block we are pointing to: */
356 FLAC__MetadataType type;
360 FLAC_API const char * const FLAC__Metadata_SimpleIteratorStatusString[] = {
361 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK",
362 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT",
363 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE",
364 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE",
365 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE",
366 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA",
367 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR",
368 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR",
369 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR",
370 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR",
371 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR",
372 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR",
373 "FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR"
377 FLAC_API FLAC__Metadata_SimpleIterator *FLAC__metadata_simple_iterator_new(void)
379 FLAC__Metadata_SimpleIterator *iterator = (FLAC__Metadata_SimpleIterator*)calloc(1, sizeof(FLAC__Metadata_SimpleIterator));
383 iterator->filename = 0;
384 iterator->tempfile_path_prefix = 0;
385 iterator->has_stats = false;
386 iterator->is_writable = false;
387 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
388 iterator->first_offset = iterator->offset[0] = -1;
395 static void simple_iterator_free_guts_(FLAC__Metadata_SimpleIterator *iterator)
397 FLAC__ASSERT(0 != iterator);
399 if(0 != iterator->file) {
400 fclose(iterator->file);
402 if(iterator->has_stats)
403 set_file_stats_(iterator->filename, &iterator->stats);
405 if(0 != iterator->filename) {
406 free(iterator->filename);
407 iterator->filename = 0;
409 if(0 != iterator->tempfile_path_prefix) {
410 free(iterator->tempfile_path_prefix);
411 iterator->tempfile_path_prefix = 0;
415 FLAC_API void FLAC__metadata_simple_iterator_delete(FLAC__Metadata_SimpleIterator *iterator)
417 FLAC__ASSERT(0 != iterator);
419 simple_iterator_free_guts_(iterator);
423 FLAC_API FLAC__Metadata_SimpleIteratorStatus FLAC__metadata_simple_iterator_status(FLAC__Metadata_SimpleIterator *iterator)
425 FLAC__Metadata_SimpleIteratorStatus status;
427 FLAC__ASSERT(0 != iterator);
429 status = iterator->status;
430 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
434 static FLAC__bool simple_iterator_prime_input_(FLAC__Metadata_SimpleIterator *iterator, FLAC__bool read_only)
438 FLAC__ASSERT(0 != iterator);
440 if(read_only || 0 == (iterator->file = fopen(iterator->filename, "r+b"))) {
441 iterator->is_writable = false;
442 if(read_only || errno == EACCES) {
443 if(0 == (iterator->file = fopen(iterator->filename, "rb"))) {
444 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE;
449 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE;
454 iterator->is_writable = true;
457 ret = seek_to_first_metadata_block_(iterator->file);
461 iterator->first_offset = iterator->offset[iterator->depth] = ftello(iterator->file);
462 return read_metadata_block_header_(iterator);
464 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
467 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
470 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE;
479 @@@ If we decide to finish implementing this, put this comment back in metadata.h
481 * The 'tempfile_path_prefix' allows you to specify a directory where
482 * tempfiles should go. Remember that if your metadata edits cause the
483 * FLAC file to grow, the entire file will have to be rewritten. If
484 * 'tempfile_path_prefix' is NULL, the temp file will be written in the
485 * same directory as the original FLAC file. This makes replacing the
486 * original with the tempfile fast but requires extra space in the same
487 * partition for the tempfile. If space is a problem, you can pass a
488 * directory name belonging to a different partition in
489 * 'tempfile_path_prefix'. Note that you should use the forward slash
490 * '/' as the directory separator. A trailing slash is not needed; it
491 * will be added automatically.
493 FLAC__bool FLAC__metadata_simple_iterator_init(FLAC__Metadata_SimpleIterator *iterator, const char *filename, FLAC__bool preserve_file_stats, const char *tempfile_path_prefix);
496 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_init(FLAC__Metadata_SimpleIterator *iterator, const char *filename, FLAC__bool read_only, FLAC__bool preserve_file_stats)
498 const char *tempfile_path_prefix = 0; /*@@@ search for comments near 'rename(...)' for what it will take to finish implementing this */
500 FLAC__ASSERT(0 != iterator);
501 FLAC__ASSERT(0 != filename);
503 simple_iterator_free_guts_(iterator);
505 if(!read_only && preserve_file_stats)
506 iterator->has_stats = get_file_stats_(filename, &iterator->stats);
508 if(0 == (iterator->filename = strdup(filename))) {
509 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
512 if(0 != tempfile_path_prefix && 0 == (iterator->tempfile_path_prefix = strdup(tempfile_path_prefix))) {
513 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
517 return simple_iterator_prime_input_(iterator, read_only);
520 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_is_writable(const FLAC__Metadata_SimpleIterator *iterator)
522 FLAC__ASSERT(0 != iterator);
523 FLAC__ASSERT(0 != iterator->file);
525 return iterator->is_writable;
528 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_next(FLAC__Metadata_SimpleIterator *iterator)
530 FLAC__ASSERT(0 != iterator);
531 FLAC__ASSERT(0 != iterator->file);
533 if(iterator->is_last)
536 if(0 != fseeko(iterator->file, iterator->length, SEEK_CUR)) {
537 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
541 iterator->offset[iterator->depth] = ftello(iterator->file);
543 return read_metadata_block_header_(iterator);
546 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_prev(FLAC__Metadata_SimpleIterator *iterator)
550 FLAC__ASSERT(0 != iterator);
551 FLAC__ASSERT(0 != iterator->file);
553 if(iterator->offset[iterator->depth] == iterator->first_offset)
556 if(0 != fseeko(iterator->file, iterator->first_offset, SEEK_SET)) {
557 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
560 this_offset = iterator->first_offset;
561 if(!read_metadata_block_header_(iterator))
564 /* we ignore any error from ftello() and catch it in fseeko() */
565 while(ftello(iterator->file) + (off_t)iterator->length < iterator->offset[iterator->depth]) {
566 if(0 != fseeko(iterator->file, iterator->length, SEEK_CUR)) {
567 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
570 this_offset = ftello(iterator->file);
571 if(!read_metadata_block_header_(iterator))
575 iterator->offset[iterator->depth] = this_offset;
580 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_is_last(const FLAC__Metadata_SimpleIterator *iterator)
582 FLAC__ASSERT(0 != iterator);
583 FLAC__ASSERT(0 != iterator->file);
585 return iterator->is_last;
588 FLAC_API off_t FLAC__metadata_simple_iterator_get_block_offset(const FLAC__Metadata_SimpleIterator *iterator)
590 FLAC__ASSERT(0 != iterator);
591 FLAC__ASSERT(0 != iterator->file);
593 return iterator->offset[iterator->depth];
596 FLAC_API FLAC__MetadataType FLAC__metadata_simple_iterator_get_block_type(const FLAC__Metadata_SimpleIterator *iterator)
598 FLAC__ASSERT(0 != iterator);
599 FLAC__ASSERT(0 != iterator->file);
601 return iterator->type;
604 FLAC_API unsigned FLAC__metadata_simple_iterator_get_block_length(const FLAC__Metadata_SimpleIterator *iterator)
606 FLAC__ASSERT(0 != iterator);
607 FLAC__ASSERT(0 != iterator->file);
609 return iterator->length;
612 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_get_application_id(FLAC__Metadata_SimpleIterator *iterator, FLAC__byte *id)
614 const unsigned id_bytes = FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8;
616 FLAC__ASSERT(0 != iterator);
617 FLAC__ASSERT(0 != iterator->file);
618 FLAC__ASSERT(0 != id);
620 if(iterator->type != FLAC__METADATA_TYPE_APPLICATION) {
621 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT;
625 if(fread(id, 1, id_bytes, iterator->file) != id_bytes) {
626 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
631 if(0 != fseeko(iterator->file, -((int)id_bytes), SEEK_CUR)) {
632 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
639 FLAC_API FLAC__StreamMetadata *FLAC__metadata_simple_iterator_get_block(FLAC__Metadata_SimpleIterator *iterator)
641 FLAC__StreamMetadata *block = FLAC__metadata_object_new(iterator->type);
643 FLAC__ASSERT(0 != iterator);
644 FLAC__ASSERT(0 != iterator->file);
647 block->is_last = iterator->is_last;
648 block->length = iterator->length;
650 if(!read_metadata_block_data_(iterator, block)) {
651 FLAC__metadata_object_delete(block);
655 /* back up to the beginning of the block data to stay consistent */
656 if(0 != fseeko(iterator->file, iterator->offset[iterator->depth] + FLAC__STREAM_METADATA_HEADER_LENGTH, SEEK_SET)) {
657 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
658 FLAC__metadata_object_delete(block);
663 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
668 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_set_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding)
670 FLAC__ASSERT_DECLARATION(off_t debug_target_offset = iterator->offset[iterator->depth];)
673 FLAC__ASSERT(0 != iterator);
674 FLAC__ASSERT(0 != iterator->file);
675 FLAC__ASSERT(0 != block);
677 if(!iterator->is_writable) {
678 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE;
682 if(iterator->type == FLAC__METADATA_TYPE_STREAMINFO || block->type == FLAC__METADATA_TYPE_STREAMINFO) {
683 if(iterator->type != block->type) {
684 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT;
689 block->is_last = iterator->is_last;
691 if(iterator->length == block->length)
692 return write_metadata_block_stationary_(iterator, block);
693 else if(iterator->length > block->length) {
694 if(use_padding && iterator->length >= FLAC__STREAM_METADATA_HEADER_LENGTH + block->length) {
695 ret = write_metadata_block_stationary_with_padding_(iterator, block, iterator->length - FLAC__STREAM_METADATA_HEADER_LENGTH - block->length, block->is_last);
696 FLAC__ASSERT(!ret || iterator->offset[iterator->depth] == debug_target_offset);
697 FLAC__ASSERT(!ret || ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
701 ret = rewrite_whole_file_(iterator, block, /*append=*/false);
702 FLAC__ASSERT(!ret || iterator->offset[iterator->depth] == debug_target_offset);
703 FLAC__ASSERT(!ret || ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
707 else /* iterator->length < block->length */ {
708 unsigned padding_leftover = 0;
709 FLAC__bool padding_is_last = false;
711 /* first see if we can even use padding */
712 if(iterator->is_last) {
716 const unsigned extra_padding_bytes_required = block->length - iterator->length;
717 simple_iterator_push_(iterator);
718 if(!FLAC__metadata_simple_iterator_next(iterator)) {
719 (void)simple_iterator_pop_(iterator);
722 if(iterator->type != FLAC__METADATA_TYPE_PADDING) {
726 if(FLAC__STREAM_METADATA_HEADER_LENGTH + iterator->length == extra_padding_bytes_required) {
727 padding_leftover = 0;
728 block->is_last = iterator->is_last;
730 else if(iterator->length < extra_padding_bytes_required)
733 padding_leftover = FLAC__STREAM_METADATA_HEADER_LENGTH + iterator->length - extra_padding_bytes_required;
734 padding_is_last = iterator->is_last;
735 block->is_last = false;
738 if(!simple_iterator_pop_(iterator))
743 if(padding_leftover == 0) {
744 ret = write_metadata_block_stationary_(iterator, block);
745 FLAC__ASSERT(!ret || iterator->offset[iterator->depth] == debug_target_offset);
746 FLAC__ASSERT(!ret || ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
750 FLAC__ASSERT(padding_leftover >= FLAC__STREAM_METADATA_HEADER_LENGTH);
751 ret = write_metadata_block_stationary_with_padding_(iterator, block, padding_leftover - FLAC__STREAM_METADATA_HEADER_LENGTH, padding_is_last);
752 FLAC__ASSERT(!ret || iterator->offset[iterator->depth] == debug_target_offset);
753 FLAC__ASSERT(!ret || ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
758 ret = rewrite_whole_file_(iterator, block, /*append=*/false);
759 FLAC__ASSERT(!ret || iterator->offset[iterator->depth] == debug_target_offset);
760 FLAC__ASSERT(!ret || ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
766 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_insert_block_after(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool use_padding)
768 unsigned padding_leftover = 0;
769 FLAC__bool padding_is_last = false;
771 FLAC__ASSERT_DECLARATION(off_t debug_target_offset = iterator->offset[iterator->depth] + FLAC__STREAM_METADATA_HEADER_LENGTH + iterator->length;)
774 FLAC__ASSERT(0 != iterator);
775 FLAC__ASSERT(0 != iterator->file);
776 FLAC__ASSERT(0 != block);
778 if(!iterator->is_writable)
781 if(block->type == FLAC__METADATA_TYPE_STREAMINFO) {
782 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT;
786 block->is_last = iterator->is_last;
789 /* first see if we can even use padding */
790 if(iterator->is_last) {
794 simple_iterator_push_(iterator);
795 if(!FLAC__metadata_simple_iterator_next(iterator)) {
796 (void)simple_iterator_pop_(iterator);
799 if(iterator->type != FLAC__METADATA_TYPE_PADDING) {
803 if(iterator->length == block->length) {
804 padding_leftover = 0;
805 block->is_last = iterator->is_last;
807 else if(iterator->length < FLAC__STREAM_METADATA_HEADER_LENGTH + block->length)
810 padding_leftover = iterator->length - block->length;
811 padding_is_last = iterator->is_last;
812 block->is_last = false;
815 if(!simple_iterator_pop_(iterator))
820 /* move to the next block, which is suitable padding */
821 if(!FLAC__metadata_simple_iterator_next(iterator))
823 if(padding_leftover == 0) {
824 ret = write_metadata_block_stationary_(iterator, block);
825 FLAC__ASSERT(iterator->offset[iterator->depth] == debug_target_offset);
826 FLAC__ASSERT(ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
830 FLAC__ASSERT(padding_leftover >= FLAC__STREAM_METADATA_HEADER_LENGTH);
831 ret = write_metadata_block_stationary_with_padding_(iterator, block, padding_leftover - FLAC__STREAM_METADATA_HEADER_LENGTH, padding_is_last);
832 FLAC__ASSERT(iterator->offset[iterator->depth] == debug_target_offset);
833 FLAC__ASSERT(ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
838 ret = rewrite_whole_file_(iterator, block, /*append=*/true);
839 FLAC__ASSERT(iterator->offset[iterator->depth] == debug_target_offset);
840 FLAC__ASSERT(ftello(iterator->file) == debug_target_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH);
845 FLAC_API FLAC__bool FLAC__metadata_simple_iterator_delete_block(FLAC__Metadata_SimpleIterator *iterator, FLAC__bool use_padding)
847 FLAC__ASSERT_DECLARATION(off_t debug_target_offset = iterator->offset[iterator->depth];)
850 if(iterator->type == FLAC__METADATA_TYPE_STREAMINFO) {
851 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT;
856 FLAC__StreamMetadata *padding = FLAC__metadata_object_new(FLAC__METADATA_TYPE_PADDING);
858 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
861 padding->length = iterator->length;
862 if(!FLAC__metadata_simple_iterator_set_block(iterator, padding, false)) {
863 FLAC__metadata_object_delete(padding);
866 FLAC__metadata_object_delete(padding);
867 if(!FLAC__metadata_simple_iterator_prev(iterator))
869 FLAC__ASSERT(iterator->offset[iterator->depth] + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH + (off_t)iterator->length == debug_target_offset);
870 FLAC__ASSERT(ftello(iterator->file) + (off_t)iterator->length == debug_target_offset);
874 ret = rewrite_whole_file_(iterator, 0, /*append=*/false);
875 FLAC__ASSERT(iterator->offset[iterator->depth] + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH + (off_t)iterator->length == debug_target_offset);
876 FLAC__ASSERT(ftello(iterator->file) + (off_t)iterator->length == debug_target_offset);
883 /****************************************************************************
885 * Level 2 implementation
887 ***************************************************************************/
890 typedef struct FLAC__Metadata_Node {
891 FLAC__StreamMetadata *data;
892 struct FLAC__Metadata_Node *prev, *next;
893 } FLAC__Metadata_Node;
895 struct FLAC__Metadata_Chain {
896 char *filename; /* will be NULL if using callbacks */
898 FLAC__Metadata_Node *head;
899 FLAC__Metadata_Node *tail;
901 FLAC__Metadata_ChainStatus status;
902 off_t first_offset, last_offset;
904 * This is the length of the chain initially read from the FLAC file.
905 * it is used to compare against the current length to decide whether
906 * or not the whole file has to be rewritten.
908 off_t initial_length;
909 /* @@@ hacky, these are currently only needed by ogg reader */
910 FLAC__IOHandle handle;
911 FLAC__IOCallback_Read read_cb;
914 struct FLAC__Metadata_Iterator {
915 FLAC__Metadata_Chain *chain;
916 FLAC__Metadata_Node *current;
919 FLAC_API const char * const FLAC__Metadata_ChainStatusString[] = {
920 "FLAC__METADATA_CHAIN_STATUS_OK",
921 "FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT",
922 "FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE",
923 "FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE",
924 "FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE",
925 "FLAC__METADATA_CHAIN_STATUS_BAD_METADATA",
926 "FLAC__METADATA_CHAIN_STATUS_READ_ERROR",
927 "FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR",
928 "FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR",
929 "FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR",
930 "FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR",
931 "FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR",
932 "FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR",
933 "FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS",
934 "FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH",
935 "FLAC__METADATA_CHAIN_STATUS_WRONG_WRITE_CALL"
939 static FLAC__Metadata_Node *node_new_(void)
941 return (FLAC__Metadata_Node*)calloc(1, sizeof(FLAC__Metadata_Node));
944 static void node_delete_(FLAC__Metadata_Node *node)
946 FLAC__ASSERT(0 != node);
948 FLAC__metadata_object_delete(node->data);
952 static void chain_init_(FLAC__Metadata_Chain *chain)
954 FLAC__ASSERT(0 != chain);
957 chain->is_ogg = false;
958 chain->head = chain->tail = 0;
960 chain->status = FLAC__METADATA_CHAIN_STATUS_OK;
961 chain->initial_length = 0;
965 static void chain_clear_(FLAC__Metadata_Chain *chain)
967 FLAC__Metadata_Node *node, *next;
969 FLAC__ASSERT(0 != chain);
971 for(node = chain->head; node; ) {
977 if(0 != chain->filename)
978 free(chain->filename);
983 static void chain_append_node_(FLAC__Metadata_Chain *chain, FLAC__Metadata_Node *node)
985 FLAC__ASSERT(0 != chain);
986 FLAC__ASSERT(0 != node);
987 FLAC__ASSERT(0 != node->data);
989 node->next = node->prev = 0;
990 node->data->is_last = true;
992 chain->tail->data->is_last = false;
997 FLAC__ASSERT(0 != chain->tail);
998 chain->tail->next = node;
999 node->prev = chain->tail;
1005 static void chain_remove_node_(FLAC__Metadata_Chain *chain, FLAC__Metadata_Node *node)
1007 FLAC__ASSERT(0 != chain);
1008 FLAC__ASSERT(0 != node);
1010 if(node == chain->head)
1011 chain->head = node->next;
1013 node->prev->next = node->next;
1015 if(node == chain->tail)
1016 chain->tail = node->prev;
1018 node->next->prev = node->prev;
1020 if(0 != chain->tail)
1021 chain->tail->data->is_last = true;
1026 static void chain_delete_node_(FLAC__Metadata_Chain *chain, FLAC__Metadata_Node *node)
1028 chain_remove_node_(chain, node);
1032 static off_t chain_calculate_length_(FLAC__Metadata_Chain *chain)
1034 const FLAC__Metadata_Node *node;
1036 for(node = chain->head; node; node = node->next)
1037 length += (FLAC__STREAM_METADATA_HEADER_LENGTH + node->data->length);
1041 static void iterator_insert_node_(FLAC__Metadata_Iterator *iterator, FLAC__Metadata_Node *node)
1043 FLAC__ASSERT(0 != node);
1044 FLAC__ASSERT(0 != node->data);
1045 FLAC__ASSERT(0 != iterator);
1046 FLAC__ASSERT(0 != iterator->current);
1047 FLAC__ASSERT(0 != iterator->chain);
1048 FLAC__ASSERT(0 != iterator->chain->head);
1049 FLAC__ASSERT(0 != iterator->chain->tail);
1051 node->data->is_last = false;
1053 node->prev = iterator->current->prev;
1054 node->next = iterator->current;
1057 iterator->chain->head = node;
1059 node->prev->next = node;
1061 iterator->current->prev = node;
1063 iterator->chain->nodes++;
1066 static void iterator_insert_node_after_(FLAC__Metadata_Iterator *iterator, FLAC__Metadata_Node *node)
1068 FLAC__ASSERT(0 != node);
1069 FLAC__ASSERT(0 != node->data);
1070 FLAC__ASSERT(0 != iterator);
1071 FLAC__ASSERT(0 != iterator->current);
1072 FLAC__ASSERT(0 != iterator->chain);
1073 FLAC__ASSERT(0 != iterator->chain->head);
1074 FLAC__ASSERT(0 != iterator->chain->tail);
1076 iterator->current->data->is_last = false;
1078 node->prev = iterator->current;
1079 node->next = iterator->current->next;
1082 iterator->chain->tail = node;
1084 node->next->prev = node;
1086 node->prev->next = node;
1088 iterator->chain->tail->data->is_last = true;
1090 iterator->chain->nodes++;
1093 /* return true iff node and node->next are both padding */
1094 static FLAC__bool chain_merge_adjacent_padding_(FLAC__Metadata_Chain *chain, FLAC__Metadata_Node *node)
1096 if(node->data->type == FLAC__METADATA_TYPE_PADDING && 0 != node->next && node->next->data->type == FLAC__METADATA_TYPE_PADDING) {
1097 const unsigned growth = FLAC__STREAM_METADATA_HEADER_LENGTH + node->next->data->length;
1098 node->data->length += growth;
1100 chain_delete_node_(chain, node->next);
1107 /* Returns the new length of the chain, or 0 if there was an error. */
1108 /* WATCHOUT: This can get called multiple times before a write, so
1109 * it should still work when this happens.
1111 /* WATCHOUT: Make sure to also update the logic in
1112 * FLAC__metadata_chain_check_if_tempfile_needed() if the logic here changes.
1114 static off_t chain_prepare_for_write_(FLAC__Metadata_Chain *chain, FLAC__bool use_padding)
1116 off_t current_length = chain_calculate_length_(chain);
1119 /* if the metadata shrank and the last block is padding, we just extend the last padding block */
1120 if(current_length < chain->initial_length && chain->tail->data->type == FLAC__METADATA_TYPE_PADDING) {
1121 const off_t delta = chain->initial_length - current_length;
1122 chain->tail->data->length += delta;
1123 current_length += delta;
1124 FLAC__ASSERT(current_length == chain->initial_length);
1126 /* if the metadata shrank more than 4 bytes then there's room to add another padding block */
1127 else if(current_length + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH <= chain->initial_length) {
1128 FLAC__StreamMetadata *padding;
1129 FLAC__Metadata_Node *node;
1130 if(0 == (padding = FLAC__metadata_object_new(FLAC__METADATA_TYPE_PADDING))) {
1131 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1134 padding->length = chain->initial_length - (FLAC__STREAM_METADATA_HEADER_LENGTH + current_length);
1135 if(0 == (node = node_new_())) {
1136 FLAC__metadata_object_delete(padding);
1137 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1140 node->data = padding;
1141 chain_append_node_(chain, node);
1142 current_length = chain_calculate_length_(chain);
1143 FLAC__ASSERT(current_length == chain->initial_length);
1145 /* if the metadata grew but the last block is padding, try cutting the padding to restore the original length so we don't have to rewrite the whole file */
1146 else if(current_length > chain->initial_length) {
1147 const off_t delta = current_length - chain->initial_length;
1148 if(chain->tail->data->type == FLAC__METADATA_TYPE_PADDING) {
1149 /* if the delta is exactly the size of the last padding block, remove the padding block */
1150 if((off_t)chain->tail->data->length + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH == delta) {
1151 chain_delete_node_(chain, chain->tail);
1152 current_length = chain_calculate_length_(chain);
1153 FLAC__ASSERT(current_length == chain->initial_length);
1155 /* if there is at least 'delta' bytes of padding, trim the padding down */
1156 else if((off_t)chain->tail->data->length >= delta) {
1157 chain->tail->data->length -= delta;
1158 current_length -= delta;
1159 FLAC__ASSERT(current_length == chain->initial_length);
1165 return current_length;
1168 static FLAC__bool chain_read_cb_(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Seek seek_cb, FLAC__IOCallback_Tell tell_cb)
1170 FLAC__Metadata_Node *node;
1172 FLAC__ASSERT(0 != chain);
1174 /* we assume we're already at the beginning of the file */
1176 switch(seek_to_first_metadata_block_cb_(handle, read_cb, seek_cb)) {
1180 chain->status = FLAC__METADATA_CHAIN_STATUS_READ_ERROR;
1183 chain->status = FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR;
1186 chain->status = FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE;
1194 FLAC__int64 pos = tell_cb(handle);
1196 chain->status = FLAC__METADATA_CHAIN_STATUS_READ_ERROR;
1199 chain->first_offset = (off_t)pos;
1204 FLAC__MetadataType type;
1210 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1214 if(!read_metadata_block_header_cb_(handle, read_cb, &is_last, &type, &length)) {
1215 chain->status = FLAC__METADATA_CHAIN_STATUS_READ_ERROR;
1219 node->data = FLAC__metadata_object_new(type);
1220 if(0 == node->data) {
1222 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1226 node->data->is_last = is_last;
1227 node->data->length = length;
1229 chain->status = get_equivalent_status_(read_metadata_block_data_cb_(handle, read_cb, seek_cb, node->data));
1230 if(chain->status != FLAC__METADATA_CHAIN_STATUS_OK) {
1234 chain_append_node_(chain, node);
1239 FLAC__int64 pos = tell_cb(handle);
1241 chain->status = FLAC__METADATA_CHAIN_STATUS_READ_ERROR;
1244 chain->last_offset = (off_t)pos;
1247 chain->initial_length = chain_calculate_length_(chain);
1252 static FLAC__StreamDecoderReadStatus chain_read_ogg_read_cb_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
1254 FLAC__Metadata_Chain *chain = (FLAC__Metadata_Chain*)client_data;
1256 if(*bytes > 0 && chain->status == FLAC__METADATA_CHAIN_STATUS_OK) {
1257 *bytes = chain->read_cb(buffer, sizeof(FLAC__byte), *bytes, chain->handle);
1259 return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
1261 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
1264 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
1267 static FLAC__StreamDecoderWriteStatus chain_read_ogg_write_cb_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
1269 (void)decoder, (void)frame, (void)buffer, (void)client_data;
1270 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
1273 static void chain_read_ogg_metadata_cb_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
1275 FLAC__Metadata_Chain *chain = (FLAC__Metadata_Chain*)client_data;
1276 FLAC__Metadata_Node *node;
1282 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1286 node->data = FLAC__metadata_object_clone(metadata);
1287 if(0 == node->data) {
1289 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1293 chain_append_node_(chain, node);
1296 static void chain_read_ogg_error_cb_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
1298 FLAC__Metadata_Chain *chain = (FLAC__Metadata_Chain*)client_data;
1299 (void)decoder, (void)status;
1300 chain->status = FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR; /*@@@ maybe needs better error code */
1303 static FLAC__bool chain_read_ogg_cb_(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb)
1305 FLAC__StreamDecoder *decoder;
1307 FLAC__ASSERT(0 != chain);
1309 /* we assume we're already at the beginning of the file */
1311 chain->handle = handle;
1312 chain->read_cb = read_cb;
1313 if(0 == (decoder = FLAC__stream_decoder_new())) {
1314 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1317 FLAC__stream_decoder_set_metadata_respond_all(decoder);
1318 if(FLAC__stream_decoder_init_ogg_stream(decoder, chain_read_ogg_read_cb_, /*seek_callback=*/0, /*tell_callback=*/0, /*length_callback=*/0, /*eof_callback=*/0, chain_read_ogg_write_cb_, chain_read_ogg_metadata_cb_, chain_read_ogg_error_cb_, chain) != FLAC__STREAM_DECODER_INIT_STATUS_OK) {
1319 FLAC__stream_decoder_delete(decoder);
1320 chain->status = FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR; /*@@@ maybe needs better error code */
1324 chain->first_offset = 0; /*@@@ wrong; will need to be set correctly to implement metadata writing for Ogg FLAC */
1326 if(!FLAC__stream_decoder_process_until_end_of_metadata(decoder))
1327 chain->status = FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR; /*@@@ maybe needs better error code */
1328 if(chain->status != FLAC__METADATA_CHAIN_STATUS_OK) {
1329 FLAC__stream_decoder_delete(decoder);
1333 FLAC__stream_decoder_delete(decoder);
1335 chain->last_offset = 0; /*@@@ wrong; will need to be set correctly to implement metadata writing for Ogg FLAC */
1337 chain->initial_length = chain_calculate_length_(chain);
1342 static FLAC__bool chain_rewrite_metadata_in_place_cb_(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, FLAC__IOCallback_Seek seek_cb)
1344 FLAC__Metadata_Node *node;
1346 FLAC__ASSERT(0 != chain);
1347 FLAC__ASSERT(0 != chain->head);
1349 if(0 != seek_cb(handle, chain->first_offset, SEEK_SET)) {
1350 chain->status = FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR;
1354 for(node = chain->head; node; node = node->next) {
1355 if(!write_metadata_block_header_cb_(handle, write_cb, node->data)) {
1356 chain->status = FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR;
1359 if(!write_metadata_block_data_cb_(handle, write_cb, node->data)) {
1360 chain->status = FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR;
1365 /*FLAC__ASSERT(fflush(), ftello() == chain->last_offset);*/
1367 chain->status = FLAC__METADATA_CHAIN_STATUS_OK;
1371 static FLAC__bool chain_rewrite_metadata_in_place_(FLAC__Metadata_Chain *chain)
1376 FLAC__ASSERT(0 != chain->filename);
1378 if(0 == (file = fopen(chain->filename, "r+b"))) {
1379 chain->status = FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE;
1383 /* chain_rewrite_metadata_in_place_cb_() sets chain->status for us */
1384 ret = chain_rewrite_metadata_in_place_cb_(chain, (FLAC__IOHandle)file, (FLAC__IOCallback_Write)fwrite, fseek_wrapper_);
1391 static FLAC__bool chain_rewrite_file_(FLAC__Metadata_Chain *chain, const char *tempfile_path_prefix)
1395 FLAC__Metadata_SimpleIteratorStatus status;
1396 const FLAC__Metadata_Node *node;
1398 FLAC__ASSERT(0 != chain);
1399 FLAC__ASSERT(0 != chain->filename);
1400 FLAC__ASSERT(0 != chain->head);
1402 /* copy the file prefix (data up to first metadata block */
1403 if(0 == (f = fopen(chain->filename, "rb"))) {
1404 chain->status = FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE;
1407 if(!open_tempfile_(chain->filename, tempfile_path_prefix, &tempfile, &tempfilename, &status)) {
1408 chain->status = get_equivalent_status_(status);
1409 cleanup_tempfile_(&tempfile, &tempfilename);
1412 if(!copy_n_bytes_from_file_(f, tempfile, chain->first_offset, &status)) {
1413 chain->status = get_equivalent_status_(status);
1414 cleanup_tempfile_(&tempfile, &tempfilename);
1418 /* write the metadata */
1419 for(node = chain->head; node; node = node->next) {
1420 if(!write_metadata_block_header_(tempfile, &status, node->data)) {
1421 chain->status = get_equivalent_status_(status);
1424 if(!write_metadata_block_data_(tempfile, &status, node->data)) {
1425 chain->status = get_equivalent_status_(status);
1429 /*FLAC__ASSERT(fflush(), ftello() == chain->last_offset);*/
1431 /* copy the file postfix (everything after the metadata) */
1432 if(0 != fseeko(f, chain->last_offset, SEEK_SET)) {
1433 cleanup_tempfile_(&tempfile, &tempfilename);
1434 chain->status = FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR;
1437 if(!copy_remaining_bytes_from_file_(f, tempfile, &status)) {
1438 cleanup_tempfile_(&tempfile, &tempfilename);
1439 chain->status = get_equivalent_status_(status);
1443 /* move the tempfile on top of the original */
1445 if(!transport_tempfile_(chain->filename, &tempfile, &tempfilename, &status))
1451 /* assumes 'handle' is already at beginning of file */
1452 static FLAC__bool chain_rewrite_file_cb_(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Seek seek_cb, FLAC__IOCallback_Eof eof_cb, FLAC__IOHandle temp_handle, FLAC__IOCallback_Write temp_write_cb)
1454 FLAC__Metadata_SimpleIteratorStatus status;
1455 const FLAC__Metadata_Node *node;
1457 FLAC__ASSERT(0 != chain);
1458 FLAC__ASSERT(0 == chain->filename);
1459 FLAC__ASSERT(0 != chain->head);
1461 /* copy the file prefix (data up to first metadata block */
1462 if(!copy_n_bytes_from_file_cb_(handle, read_cb, temp_handle, temp_write_cb, chain->first_offset, &status)) {
1463 chain->status = get_equivalent_status_(status);
1467 /* write the metadata */
1468 for(node = chain->head; node; node = node->next) {
1469 if(!write_metadata_block_header_cb_(temp_handle, temp_write_cb, node->data)) {
1470 chain->status = FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR;
1473 if(!write_metadata_block_data_cb_(temp_handle, temp_write_cb, node->data)) {
1474 chain->status = FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR;
1478 /*FLAC__ASSERT(fflush(), ftello() == chain->last_offset);*/
1480 /* copy the file postfix (everything after the metadata) */
1481 if(0 != seek_cb(handle, chain->last_offset, SEEK_SET)) {
1482 chain->status = FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR;
1485 if(!copy_remaining_bytes_from_file_cb_(handle, read_cb, eof_cb, temp_handle, temp_write_cb, &status)) {
1486 chain->status = get_equivalent_status_(status);
1493 FLAC_API FLAC__Metadata_Chain *FLAC__metadata_chain_new(void)
1495 FLAC__Metadata_Chain *chain = (FLAC__Metadata_Chain*)calloc(1, sizeof(FLAC__Metadata_Chain));
1503 FLAC_API void FLAC__metadata_chain_delete(FLAC__Metadata_Chain *chain)
1505 FLAC__ASSERT(0 != chain);
1507 chain_clear_(chain);
1512 FLAC_API FLAC__Metadata_ChainStatus FLAC__metadata_chain_status(FLAC__Metadata_Chain *chain)
1514 FLAC__Metadata_ChainStatus status;
1516 FLAC__ASSERT(0 != chain);
1518 status = chain->status;
1519 chain->status = FLAC__METADATA_CHAIN_STATUS_OK;
1523 static FLAC__bool chain_read_(FLAC__Metadata_Chain *chain, const char *filename, FLAC__bool is_ogg)
1528 FLAC__ASSERT(0 != chain);
1529 FLAC__ASSERT(0 != filename);
1531 chain_clear_(chain);
1533 if(0 == (chain->filename = strdup(filename))) {
1534 chain->status = FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
1538 chain->is_ogg = is_ogg;
1540 if(0 == (file = fopen(filename, "rb"))) {
1541 chain->status = FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE;
1545 /* the function also sets chain->status for us */
1547 chain_read_ogg_cb_(chain, file, (FLAC__IOCallback_Read)fread) :
1548 chain_read_cb_(chain, file, (FLAC__IOCallback_Read)fread, fseek_wrapper_, ftell_wrapper_)
1556 FLAC_API FLAC__bool FLAC__metadata_chain_read(FLAC__Metadata_Chain *chain, const char *filename)
1558 return chain_read_(chain, filename, /*is_ogg=*/false);
1561 FLAC_API FLAC__bool FLAC__metadata_chain_read_ogg(FLAC__Metadata_Chain *chain, const char *filename)
1563 return chain_read_(chain, filename, /*is_ogg=*/true);
1566 static FLAC__bool chain_read_with_callbacks_(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks, FLAC__bool is_ogg)
1570 FLAC__ASSERT(0 != chain);
1572 chain_clear_(chain);
1574 if (0 == callbacks.read || 0 == callbacks.seek || 0 == callbacks.tell) {
1575 chain->status = FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS;
1579 chain->is_ogg = is_ogg;
1582 if(0 != callbacks.seek(handle, 0, SEEK_SET)) {
1583 chain->status = FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR;
1587 /* the function also sets chain->status for us */
1589 chain_read_ogg_cb_(chain, handle, callbacks.read) :
1590 chain_read_cb_(chain, handle, callbacks.read, callbacks.seek, callbacks.tell)
1596 FLAC_API FLAC__bool FLAC__metadata_chain_read_with_callbacks(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks)
1598 return chain_read_with_callbacks_(chain, handle, callbacks, /*is_ogg=*/false);
1601 FLAC_API FLAC__bool FLAC__metadata_chain_read_ogg_with_callbacks(FLAC__Metadata_Chain *chain, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks)
1603 return chain_read_with_callbacks_(chain, handle, callbacks, /*is_ogg=*/true);
1606 FLAC_API FLAC__bool FLAC__metadata_chain_check_if_tempfile_needed(FLAC__Metadata_Chain *chain, FLAC__bool use_padding)
1608 /* This does all the same checks that are in chain_prepare_for_write_()
1609 * but doesn't actually alter the chain. Make sure to update the logic
1610 * here if chain_prepare_for_write_() changes.
1612 const off_t current_length = chain_calculate_length_(chain);
1614 FLAC__ASSERT(0 != chain);
1617 /* if the metadata shrank and the last block is padding, we just extend the last padding block */
1618 if(current_length < chain->initial_length && chain->tail->data->type == FLAC__METADATA_TYPE_PADDING)
1620 /* if the metadata shrank more than 4 bytes then there's room to add another padding block */
1621 else if(current_length + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH <= chain->initial_length)
1623 /* if the metadata grew but the last block is padding, try cutting the padding to restore the original length so we don't have to rewrite the whole file */
1624 else if(current_length > chain->initial_length) {
1625 const off_t delta = current_length - chain->initial_length;
1626 if(chain->tail->data->type == FLAC__METADATA_TYPE_PADDING) {
1627 /* if the delta is exactly the size of the last padding block, remove the padding block */
1628 if((off_t)chain->tail->data->length + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH == delta)
1630 /* if there is at least 'delta' bytes of padding, trim the padding down */
1631 else if((off_t)chain->tail->data->length >= delta)
1637 return (current_length != chain->initial_length);
1640 FLAC_API FLAC__bool FLAC__metadata_chain_write(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__bool preserve_file_stats)
1643 const char *tempfile_path_prefix = 0;
1644 off_t current_length;
1646 FLAC__ASSERT(0 != chain);
1648 if (chain->is_ogg) { /* cannot write back to Ogg FLAC yet */
1649 chain->status = FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR;
1653 if (0 == chain->filename) {
1654 chain->status = FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH;
1658 current_length = chain_prepare_for_write_(chain, use_padding);
1660 /* a return value of 0 means there was an error; chain->status is already set */
1661 if (0 == current_length)
1664 if(preserve_file_stats)
1665 get_file_stats_(chain->filename, &stats);
1667 if(current_length == chain->initial_length) {
1668 if(!chain_rewrite_metadata_in_place_(chain))
1672 if(!chain_rewrite_file_(chain, tempfile_path_prefix))
1675 /* recompute lengths and offsets */
1677 const FLAC__Metadata_Node *node;
1678 chain->initial_length = current_length;
1679 chain->last_offset = chain->first_offset;
1680 for(node = chain->head; node; node = node->next)
1681 chain->last_offset += (FLAC__STREAM_METADATA_HEADER_LENGTH + node->data->length);
1685 if(preserve_file_stats)
1686 set_file_stats_(chain->filename, &stats);
1691 FLAC_API FLAC__bool FLAC__metadata_chain_write_with_callbacks(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks)
1693 off_t current_length;
1695 FLAC__ASSERT(0 != chain);
1697 if (chain->is_ogg) { /* cannot write back to Ogg FLAC yet */
1698 chain->status = FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR;
1702 if (0 != chain->filename) {
1703 chain->status = FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH;
1707 if (0 == callbacks.write || 0 == callbacks.seek) {
1708 chain->status = FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS;
1712 if (FLAC__metadata_chain_check_if_tempfile_needed(chain, use_padding)) {
1713 chain->status = FLAC__METADATA_CHAIN_STATUS_WRONG_WRITE_CALL;
1717 current_length = chain_prepare_for_write_(chain, use_padding);
1719 /* a return value of 0 means there was an error; chain->status is already set */
1720 if (0 == current_length)
1723 FLAC__ASSERT(current_length == chain->initial_length);
1725 return chain_rewrite_metadata_in_place_cb_(chain, handle, callbacks.write, callbacks.seek);
1728 FLAC_API FLAC__bool FLAC__metadata_chain_write_with_callbacks_and_tempfile(FLAC__Metadata_Chain *chain, FLAC__bool use_padding, FLAC__IOHandle handle, FLAC__IOCallbacks callbacks, FLAC__IOHandle temp_handle, FLAC__IOCallbacks temp_callbacks)
1730 off_t current_length;
1732 FLAC__ASSERT(0 != chain);
1734 if (chain->is_ogg) { /* cannot write back to Ogg FLAC yet */
1735 chain->status = FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR;
1739 if (0 != chain->filename) {
1740 chain->status = FLAC__METADATA_CHAIN_STATUS_READ_WRITE_MISMATCH;
1744 if (0 == callbacks.read || 0 == callbacks.seek || 0 == callbacks.eof) {
1745 chain->status = FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS;
1748 if (0 == temp_callbacks.write) {
1749 chain->status = FLAC__METADATA_CHAIN_STATUS_INVALID_CALLBACKS;
1753 if (!FLAC__metadata_chain_check_if_tempfile_needed(chain, use_padding)) {
1754 chain->status = FLAC__METADATA_CHAIN_STATUS_WRONG_WRITE_CALL;
1758 current_length = chain_prepare_for_write_(chain, use_padding);
1760 /* a return value of 0 means there was an error; chain->status is already set */
1761 if (0 == current_length)
1764 FLAC__ASSERT(current_length != chain->initial_length);
1767 if(0 != callbacks.seek(handle, 0, SEEK_SET)) {
1768 chain->status = FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR;
1772 if(!chain_rewrite_file_cb_(chain, handle, callbacks.read, callbacks.seek, callbacks.eof, temp_handle, temp_callbacks.write))
1775 /* recompute lengths and offsets */
1777 const FLAC__Metadata_Node *node;
1778 chain->initial_length = current_length;
1779 chain->last_offset = chain->first_offset;
1780 for(node = chain->head; node; node = node->next)
1781 chain->last_offset += (FLAC__STREAM_METADATA_HEADER_LENGTH + node->data->length);
1787 FLAC_API void FLAC__metadata_chain_merge_padding(FLAC__Metadata_Chain *chain)
1789 FLAC__Metadata_Node *node;
1791 FLAC__ASSERT(0 != chain);
1793 for(node = chain->head; node; ) {
1794 if(!chain_merge_adjacent_padding_(chain, node))
1799 FLAC_API void FLAC__metadata_chain_sort_padding(FLAC__Metadata_Chain *chain)
1801 FLAC__Metadata_Node *node, *save;
1804 FLAC__ASSERT(0 != chain);
1807 * Don't try and be too smart... this simple algo is good enough for
1808 * the small number of nodes that we deal with.
1810 for(i = 0, node = chain->head; i < chain->nodes; i++) {
1811 if(node->data->type == FLAC__METADATA_TYPE_PADDING) {
1813 chain_remove_node_(chain, node);
1814 chain_append_node_(chain, node);
1822 FLAC__metadata_chain_merge_padding(chain);
1826 FLAC_API FLAC__Metadata_Iterator *FLAC__metadata_iterator_new(void)
1828 FLAC__Metadata_Iterator *iterator = (FLAC__Metadata_Iterator*)calloc(1, sizeof(FLAC__Metadata_Iterator));
1830 /* calloc() implies:
1831 iterator->current = 0;
1832 iterator->chain = 0;
1838 FLAC_API void FLAC__metadata_iterator_delete(FLAC__Metadata_Iterator *iterator)
1840 FLAC__ASSERT(0 != iterator);
1845 FLAC_API void FLAC__metadata_iterator_init(FLAC__Metadata_Iterator *iterator, FLAC__Metadata_Chain *chain)
1847 FLAC__ASSERT(0 != iterator);
1848 FLAC__ASSERT(0 != chain);
1849 FLAC__ASSERT(0 != chain->head);
1851 iterator->chain = chain;
1852 iterator->current = chain->head;
1855 FLAC_API FLAC__bool FLAC__metadata_iterator_next(FLAC__Metadata_Iterator *iterator)
1857 FLAC__ASSERT(0 != iterator);
1859 if(0 == iterator->current || 0 == iterator->current->next)
1862 iterator->current = iterator->current->next;
1866 FLAC_API FLAC__bool FLAC__metadata_iterator_prev(FLAC__Metadata_Iterator *iterator)
1868 FLAC__ASSERT(0 != iterator);
1870 if(0 == iterator->current || 0 == iterator->current->prev)
1873 iterator->current = iterator->current->prev;
1877 FLAC_API FLAC__MetadataType FLAC__metadata_iterator_get_block_type(const FLAC__Metadata_Iterator *iterator)
1879 FLAC__ASSERT(0 != iterator);
1880 FLAC__ASSERT(0 != iterator->current);
1881 FLAC__ASSERT(0 != iterator->current->data);
1883 return iterator->current->data->type;
1886 FLAC_API FLAC__StreamMetadata *FLAC__metadata_iterator_get_block(FLAC__Metadata_Iterator *iterator)
1888 FLAC__ASSERT(0 != iterator);
1889 FLAC__ASSERT(0 != iterator->current);
1891 return iterator->current->data;
1894 FLAC_API FLAC__bool FLAC__metadata_iterator_set_block(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block)
1896 FLAC__ASSERT(0 != iterator);
1897 FLAC__ASSERT(0 != block);
1898 return FLAC__metadata_iterator_delete_block(iterator, false) && FLAC__metadata_iterator_insert_block_after(iterator, block);
1901 FLAC_API FLAC__bool FLAC__metadata_iterator_delete_block(FLAC__Metadata_Iterator *iterator, FLAC__bool replace_with_padding)
1903 FLAC__Metadata_Node *save;
1905 FLAC__ASSERT(0 != iterator);
1906 FLAC__ASSERT(0 != iterator->current);
1908 if(0 == iterator->current->prev) {
1909 FLAC__ASSERT(iterator->current->data->type == FLAC__METADATA_TYPE_STREAMINFO);
1913 save = iterator->current->prev;
1915 if(replace_with_padding) {
1916 FLAC__metadata_object_delete_data(iterator->current->data);
1917 iterator->current->data->type = FLAC__METADATA_TYPE_PADDING;
1920 chain_delete_node_(iterator->chain, iterator->current);
1923 iterator->current = save;
1927 FLAC_API FLAC__bool FLAC__metadata_iterator_insert_block_before(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block)
1929 FLAC__Metadata_Node *node;
1931 FLAC__ASSERT(0 != iterator);
1932 FLAC__ASSERT(0 != iterator->current);
1933 FLAC__ASSERT(0 != block);
1935 if(block->type == FLAC__METADATA_TYPE_STREAMINFO)
1938 if(0 == iterator->current->prev) {
1939 FLAC__ASSERT(iterator->current->data->type == FLAC__METADATA_TYPE_STREAMINFO);
1943 if(0 == (node = node_new_()))
1947 iterator_insert_node_(iterator, node);
1948 iterator->current = node;
1952 FLAC_API FLAC__bool FLAC__metadata_iterator_insert_block_after(FLAC__Metadata_Iterator *iterator, FLAC__StreamMetadata *block)
1954 FLAC__Metadata_Node *node;
1956 FLAC__ASSERT(0 != iterator);
1957 FLAC__ASSERT(0 != iterator->current);
1958 FLAC__ASSERT(0 != block);
1960 if(block->type == FLAC__METADATA_TYPE_STREAMINFO)
1963 if(0 == (node = node_new_()))
1967 iterator_insert_node_after_(iterator, node);
1968 iterator->current = node;
1973 /****************************************************************************
1975 * Local function definitions
1977 ***************************************************************************/
1979 void pack_uint32_(FLAC__uint32 val, FLAC__byte *b, unsigned bytes)
1985 for(i = 0; i < bytes; i++) {
1986 *(--b) = (FLAC__byte)(val & 0xff);
1991 void pack_uint32_little_endian_(FLAC__uint32 val, FLAC__byte *b, unsigned bytes)
1995 for(i = 0; i < bytes; i++) {
1996 *(b++) = (FLAC__byte)(val & 0xff);
2001 void pack_uint64_(FLAC__uint64 val, FLAC__byte *b, unsigned bytes)
2007 for(i = 0; i < bytes; i++) {
2008 *(--b) = (FLAC__byte)(val & 0xff);
2013 FLAC__uint32 unpack_uint32_(FLAC__byte *b, unsigned bytes)
2015 FLAC__uint32 ret = 0;
2018 for(i = 0; i < bytes; i++)
2019 ret = (ret << 8) | (FLAC__uint32)(*b++);
2024 FLAC__uint32 unpack_uint32_little_endian_(FLAC__byte *b, unsigned bytes)
2026 FLAC__uint32 ret = 0;
2031 for(i = 0; i < bytes; i++)
2032 ret = (ret << 8) | (FLAC__uint32)(*--b);
2037 FLAC__uint64 unpack_uint64_(FLAC__byte *b, unsigned bytes)
2039 FLAC__uint64 ret = 0;
2042 for(i = 0; i < bytes; i++)
2043 ret = (ret << 8) | (FLAC__uint64)(*b++);
2048 FLAC__bool read_metadata_block_header_(FLAC__Metadata_SimpleIterator *iterator)
2050 FLAC__ASSERT(0 != iterator);
2051 FLAC__ASSERT(0 != iterator->file);
2053 if(!read_metadata_block_header_cb_((FLAC__IOHandle)iterator->file, (FLAC__IOCallback_Read)fread, &iterator->is_last, &iterator->type, &iterator->length)) {
2054 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2061 FLAC__bool read_metadata_block_data_(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block)
2063 FLAC__ASSERT(0 != iterator);
2064 FLAC__ASSERT(0 != iterator->file);
2066 iterator->status = read_metadata_block_data_cb_((FLAC__IOHandle)iterator->file, (FLAC__IOCallback_Read)fread, fseek_wrapper_, block);
2068 return (iterator->status == FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK);
2071 FLAC__bool read_metadata_block_header_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__bool *is_last, FLAC__MetadataType *type, unsigned *length)
2073 FLAC__byte raw_header[FLAC__STREAM_METADATA_HEADER_LENGTH];
2075 if(read_cb(raw_header, 1, FLAC__STREAM_METADATA_HEADER_LENGTH, handle) != FLAC__STREAM_METADATA_HEADER_LENGTH)
2078 *is_last = raw_header[0] & 0x80? true : false;
2079 *type = (FLAC__MetadataType)(raw_header[0] & 0x7f);
2080 *length = unpack_uint32_(raw_header + 1, 3);
2082 /* Note that we don't check:
2083 * if(iterator->type >= FLAC__METADATA_TYPE_UNDEFINED)
2084 * we just will read in an opaque block
2090 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Seek seek_cb, FLAC__StreamMetadata *block)
2092 switch(block->type) {
2093 case FLAC__METADATA_TYPE_STREAMINFO:
2094 return read_metadata_block_data_streaminfo_cb_(handle, read_cb, &block->data.stream_info);
2095 case FLAC__METADATA_TYPE_PADDING:
2096 return read_metadata_block_data_padding_cb_(handle, seek_cb, &block->data.padding, block->length);
2097 case FLAC__METADATA_TYPE_APPLICATION:
2098 return read_metadata_block_data_application_cb_(handle, read_cb, &block->data.application, block->length);
2099 case FLAC__METADATA_TYPE_SEEKTABLE:
2100 return read_metadata_block_data_seektable_cb_(handle, read_cb, &block->data.seek_table, block->length);
2101 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
2102 return read_metadata_block_data_vorbis_comment_cb_(handle, read_cb, &block->data.vorbis_comment);
2103 case FLAC__METADATA_TYPE_CUESHEET:
2104 return read_metadata_block_data_cuesheet_cb_(handle, read_cb, &block->data.cue_sheet);
2105 case FLAC__METADATA_TYPE_PICTURE:
2106 return read_metadata_block_data_picture_cb_(handle, read_cb, &block->data.picture);
2108 return read_metadata_block_data_unknown_cb_(handle, read_cb, &block->data.unknown, block->length);
2112 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_streaminfo_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_StreamInfo *block)
2114 FLAC__byte buffer[FLAC__STREAM_METADATA_STREAMINFO_LENGTH], *b;
2116 if(read_cb(buffer, 1, FLAC__STREAM_METADATA_STREAMINFO_LENGTH, handle) != FLAC__STREAM_METADATA_STREAMINFO_LENGTH)
2117 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2121 /* we are using hardcoded numbers for simplicity but we should
2122 * probably eventually write a bit-level unpacker and use the
2123 * _STREAMINFO_ constants.
2125 block->min_blocksize = unpack_uint32_(b, 2); b += 2;
2126 block->max_blocksize = unpack_uint32_(b, 2); b += 2;
2127 block->min_framesize = unpack_uint32_(b, 3); b += 3;
2128 block->max_framesize = unpack_uint32_(b, 3); b += 3;
2129 block->sample_rate = (unpack_uint32_(b, 2) << 4) | ((unsigned)(b[2] & 0xf0) >> 4);
2130 block->channels = (unsigned)((b[2] & 0x0e) >> 1) + 1;
2131 block->bits_per_sample = ((((unsigned)(b[2] & 0x01)) << 4) | (((unsigned)(b[3] & 0xf0)) >> 4)) + 1;
2132 block->total_samples = (((FLAC__uint64)(b[3] & 0x0f)) << 32) | unpack_uint64_(b+4, 4);
2133 memcpy(block->md5sum, b+8, 16);
2135 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2138 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_padding_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Seek seek_cb, FLAC__StreamMetadata_Padding *block, unsigned block_length)
2140 (void)block; /* nothing to do; we don't care about reading the padding bytes */
2142 if(0 != seek_cb(handle, block_length, SEEK_CUR))
2143 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
2145 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2148 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_application_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_Application *block, unsigned block_length)
2150 const unsigned id_bytes = FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8;
2152 if(read_cb(block->id, 1, id_bytes, handle) != id_bytes)
2153 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2155 block_length -= id_bytes;
2157 if(block_length == 0) {
2161 if(0 == (block->data = (FLAC__byte*)malloc(block_length)))
2162 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2164 if(read_cb(block->data, 1, block_length, handle) != block_length)
2165 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2168 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2171 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_seektable_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_SeekTable *block, unsigned block_length)
2174 FLAC__byte buffer[FLAC__STREAM_METADATA_SEEKPOINT_LENGTH];
2176 FLAC__ASSERT(block_length % FLAC__STREAM_METADATA_SEEKPOINT_LENGTH == 0);
2178 block->num_points = block_length / FLAC__STREAM_METADATA_SEEKPOINT_LENGTH;
2180 if(block->num_points == 0)
2182 else if(0 == (block->points = (FLAC__StreamMetadata_SeekPoint*)malloc(block->num_points * sizeof(FLAC__StreamMetadata_SeekPoint))))
2183 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2185 for(i = 0; i < block->num_points; i++) {
2186 if(read_cb(buffer, 1, FLAC__STREAM_METADATA_SEEKPOINT_LENGTH, handle) != FLAC__STREAM_METADATA_SEEKPOINT_LENGTH)
2187 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2188 /* some MAGIC NUMBERs here */
2189 block->points[i].sample_number = unpack_uint64_(buffer, 8);
2190 block->points[i].stream_offset = unpack_uint64_(buffer+8, 8);
2191 block->points[i].frame_samples = unpack_uint32_(buffer+16, 2);
2194 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2197 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_vorbis_comment_entry_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_VorbisComment_Entry *entry)
2199 const unsigned entry_length_len = FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN / 8;
2200 FLAC__byte buffer[4]; /* magic number is asserted below */
2202 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN / 8 == sizeof(buffer));
2204 if(read_cb(buffer, 1, entry_length_len, handle) != entry_length_len)
2205 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2206 entry->length = unpack_uint32_little_endian_(buffer, entry_length_len);
2208 if(0 != entry->entry)
2211 if(entry->length == 0) {
2215 if(0 == (entry->entry = (FLAC__byte*)malloc(entry->length+1)))
2216 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2218 if(read_cb(entry->entry, 1, entry->length, handle) != entry->length)
2219 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2221 entry->entry[entry->length] = '\0';
2224 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2227 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_vorbis_comment_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_VorbisComment *block)
2230 FLAC__Metadata_SimpleIteratorStatus status;
2231 const unsigned num_comments_len = FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN / 8;
2232 FLAC__byte buffer[4]; /* magic number is asserted below */
2234 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN / 8 == sizeof(buffer));
2236 if(FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK != (status = read_metadata_block_data_vorbis_comment_entry_cb_(handle, read_cb, &(block->vendor_string))))
2239 if(read_cb(buffer, 1, num_comments_len, handle) != num_comments_len)
2240 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2241 block->num_comments = unpack_uint32_little_endian_(buffer, num_comments_len);
2243 if(block->num_comments == 0) {
2244 block->comments = 0;
2246 else if(0 == (block->comments = (FLAC__StreamMetadata_VorbisComment_Entry*)calloc(block->num_comments, sizeof(FLAC__StreamMetadata_VorbisComment_Entry))))
2247 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2249 for(i = 0; i < block->num_comments; i++) {
2250 if(FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK != (status = read_metadata_block_data_vorbis_comment_entry_cb_(handle, read_cb, block->comments + i)))
2254 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2257 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_cuesheet_track_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_CueSheet_Track *track)
2260 FLAC__byte buffer[32]; /* asserted below that this is big enough */
2262 FLAC__ASSERT(sizeof(buffer) >= sizeof(FLAC__uint64));
2263 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN/8);
2264 FLAC__ASSERT(sizeof(buffer) >= (FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN) / 8);
2266 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN % 8 == 0);
2267 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN / 8;
2268 if(read_cb(buffer, 1, len, handle) != len)
2269 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2270 track->offset = unpack_uint64_(buffer, len);
2272 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN % 8 == 0);
2273 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN / 8;
2274 if(read_cb(buffer, 1, len, handle) != len)
2275 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2276 track->number = (FLAC__byte)unpack_uint32_(buffer, len);
2278 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN % 8 == 0);
2279 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN / 8;
2280 if(read_cb(track->isrc, 1, len, handle) != len)
2281 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2283 FLAC__ASSERT((FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN) % 8 == 0);
2284 len = (FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN) / 8;
2285 if(read_cb(buffer, 1, len, handle) != len)
2286 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2287 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN == 1);
2288 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN == 1);
2289 track->type = buffer[0] >> 7;
2290 track->pre_emphasis = (buffer[0] >> 6) & 1;
2292 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN % 8 == 0);
2293 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN / 8;
2294 if(read_cb(buffer, 1, len, handle) != len)
2295 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2296 track->num_indices = (FLAC__byte)unpack_uint32_(buffer, len);
2298 if(track->num_indices == 0) {
2301 else if(0 == (track->indices = (FLAC__StreamMetadata_CueSheet_Index*)calloc(track->num_indices, sizeof(FLAC__StreamMetadata_CueSheet_Index))))
2302 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2304 for(i = 0; i < track->num_indices; i++) {
2305 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN % 8 == 0);
2306 len = FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN / 8;
2307 if(read_cb(buffer, 1, len, handle) != len)
2308 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2309 track->indices[i].offset = unpack_uint64_(buffer, len);
2311 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN % 8 == 0);
2312 len = FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN / 8;
2313 if(read_cb(buffer, 1, len, handle) != len)
2314 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2315 track->indices[i].number = (FLAC__byte)unpack_uint32_(buffer, len);
2317 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN % 8 == 0);
2318 len = FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN / 8;
2319 if(read_cb(buffer, 1, len, handle) != len)
2320 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2323 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2326 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_cuesheet_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_CueSheet *block)
2329 FLAC__Metadata_SimpleIteratorStatus status;
2330 FLAC__byte buffer[1024]; /* MSVC needs a constant expression so we put a magic number and assert */
2332 FLAC__ASSERT((FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN + FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN)/8 <= sizeof(buffer));
2333 FLAC__ASSERT(sizeof(FLAC__uint64) <= sizeof(buffer));
2335 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN % 8 == 0);
2336 len = FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN / 8;
2337 if(read_cb(block->media_catalog_number, 1, len, handle) != len)
2338 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2340 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN % 8 == 0);
2341 len = FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN / 8;
2342 if(read_cb(buffer, 1, len, handle) != len)
2343 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2344 block->lead_in = unpack_uint64_(buffer, len);
2346 FLAC__ASSERT((FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN + FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN) % 8 == 0);
2347 len = (FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN + FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN) / 8;
2348 if(read_cb(buffer, 1, len, handle) != len)
2349 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2350 block->is_cd = buffer[0]&0x80? true : false;
2352 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN % 8 == 0);
2353 len = FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN / 8;
2354 if(read_cb(buffer, 1, len, handle) != len)
2355 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2356 block->num_tracks = unpack_uint32_(buffer, len);
2358 if(block->num_tracks == 0) {
2361 else if(0 == (block->tracks = (FLAC__StreamMetadata_CueSheet_Track*)calloc(block->num_tracks, sizeof(FLAC__StreamMetadata_CueSheet_Track))))
2362 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2364 for(i = 0; i < block->num_tracks; i++) {
2365 if(FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK != (status = read_metadata_block_data_cuesheet_track_cb_(handle, read_cb, block->tracks + i)))
2369 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2372 static FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_picture_cstring_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__byte **data, FLAC__uint32 *length, FLAC__uint32 length_len)
2374 FLAC__byte buffer[sizeof(FLAC__uint32)];
2376 FLAC__ASSERT(0 != data);
2377 FLAC__ASSERT(length_len%8 == 0);
2379 length_len /= 8; /* convert to bytes */
2381 FLAC__ASSERT(sizeof(buffer) >= length_len);
2383 if(read_cb(buffer, 1, length_len, handle) != length_len)
2384 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2385 *length = unpack_uint32_(buffer, length_len);
2390 if(0 == (*data = (FLAC__byte*)malloc(*length+1)))
2391 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2394 if(read_cb(*data, 1, *length, handle) != *length)
2395 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2398 (*data)[*length] = '\0';
2400 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2403 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_picture_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_Picture *block)
2405 FLAC__Metadata_SimpleIteratorStatus status;
2406 FLAC__byte buffer[4]; /* asserted below that this is big enough */
2409 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_TYPE_LEN/8);
2410 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN/8);
2411 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN/8);
2412 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN/8);
2413 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_COLORS_LEN/8);
2415 FLAC__ASSERT(FLAC__STREAM_METADATA_PICTURE_TYPE_LEN % 8 == 0);
2416 len = FLAC__STREAM_METADATA_PICTURE_TYPE_LEN / 8;
2417 if(read_cb(buffer, 1, len, handle) != len)
2418 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2419 block->type = (FLAC__StreamMetadata_Picture_Type)unpack_uint32_(buffer, len);
2421 if((status = read_metadata_block_data_picture_cstring_cb_(handle, read_cb, (FLAC__byte**)(&(block->mime_type)), &len, FLAC__STREAM_METADATA_PICTURE_MIME_TYPE_LENGTH_LEN)) != FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK)
2424 if((status = read_metadata_block_data_picture_cstring_cb_(handle, read_cb, &(block->description), &len, FLAC__STREAM_METADATA_PICTURE_DESCRIPTION_LENGTH_LEN)) != FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK)
2427 FLAC__ASSERT(FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN % 8 == 0);
2428 len = FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN / 8;
2429 if(read_cb(buffer, 1, len, handle) != len)
2430 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2431 block->width = unpack_uint32_(buffer, len);
2433 FLAC__ASSERT(FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN % 8 == 0);
2434 len = FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN / 8;
2435 if(read_cb(buffer, 1, len, handle) != len)
2436 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2437 block->height = unpack_uint32_(buffer, len);
2439 FLAC__ASSERT(FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN % 8 == 0);
2440 len = FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN / 8;
2441 if(read_cb(buffer, 1, len, handle) != len)
2442 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2443 block->depth = unpack_uint32_(buffer, len);
2445 FLAC__ASSERT(FLAC__STREAM_METADATA_PICTURE_COLORS_LEN % 8 == 0);
2446 len = FLAC__STREAM_METADATA_PICTURE_COLORS_LEN / 8;
2447 if(read_cb(buffer, 1, len, handle) != len)
2448 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2449 block->colors = unpack_uint32_(buffer, len);
2451 /* for convenience we use read_metadata_block_data_picture_cstring_cb_() even though it adds an extra terminating NUL we don't use */
2452 if((status = read_metadata_block_data_picture_cstring_cb_(handle, read_cb, &(block->data), &(block->data_length), FLAC__STREAM_METADATA_PICTURE_DATA_LENGTH_LEN)) != FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK)
2455 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2458 FLAC__Metadata_SimpleIteratorStatus read_metadata_block_data_unknown_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__StreamMetadata_Unknown *block, unsigned block_length)
2460 if(block_length == 0) {
2464 if(0 == (block->data = (FLAC__byte*)malloc(block_length)))
2465 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2467 if(read_cb(block->data, 1, block_length, handle) != block_length)
2468 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
2471 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2474 FLAC__bool write_metadata_block_header_(FILE *file, FLAC__Metadata_SimpleIteratorStatus *status, const FLAC__StreamMetadata *block)
2476 FLAC__ASSERT(0 != file);
2477 FLAC__ASSERT(0 != status);
2479 if(!write_metadata_block_header_cb_((FLAC__IOHandle)file, (FLAC__IOCallback_Write)fwrite, block)) {
2480 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR;
2487 FLAC__bool write_metadata_block_data_(FILE *file, FLAC__Metadata_SimpleIteratorStatus *status, const FLAC__StreamMetadata *block)
2489 FLAC__ASSERT(0 != file);
2490 FLAC__ASSERT(0 != status);
2492 if (write_metadata_block_data_cb_((FLAC__IOHandle)file, (FLAC__IOCallback_Write)fwrite, block)) {
2493 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK;
2497 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR;
2502 FLAC__bool write_metadata_block_header_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata *block)
2504 FLAC__byte buffer[FLAC__STREAM_METADATA_HEADER_LENGTH];
2506 FLAC__ASSERT(block->length < (1u << FLAC__STREAM_METADATA_LENGTH_LEN));
2508 buffer[0] = (block->is_last? 0x80 : 0) | (FLAC__byte)block->type;
2509 pack_uint32_(block->length, buffer + 1, 3);
2511 if(write_cb(buffer, 1, FLAC__STREAM_METADATA_HEADER_LENGTH, handle) != FLAC__STREAM_METADATA_HEADER_LENGTH)
2517 FLAC__bool write_metadata_block_data_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata *block)
2519 FLAC__ASSERT(0 != block);
2521 switch(block->type) {
2522 case FLAC__METADATA_TYPE_STREAMINFO:
2523 return write_metadata_block_data_streaminfo_cb_(handle, write_cb, &block->data.stream_info);
2524 case FLAC__METADATA_TYPE_PADDING:
2525 return write_metadata_block_data_padding_cb_(handle, write_cb, &block->data.padding, block->length);
2526 case FLAC__METADATA_TYPE_APPLICATION:
2527 return write_metadata_block_data_application_cb_(handle, write_cb, &block->data.application, block->length);
2528 case FLAC__METADATA_TYPE_SEEKTABLE:
2529 return write_metadata_block_data_seektable_cb_(handle, write_cb, &block->data.seek_table);
2530 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
2531 return write_metadata_block_data_vorbis_comment_cb_(handle, write_cb, &block->data.vorbis_comment);
2532 case FLAC__METADATA_TYPE_CUESHEET:
2533 return write_metadata_block_data_cuesheet_cb_(handle, write_cb, &block->data.cue_sheet);
2534 case FLAC__METADATA_TYPE_PICTURE:
2535 return write_metadata_block_data_picture_cb_(handle, write_cb, &block->data.picture);
2537 return write_metadata_block_data_unknown_cb_(handle, write_cb, &block->data.unknown, block->length);
2541 FLAC__bool write_metadata_block_data_streaminfo_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_StreamInfo *block)
2543 FLAC__byte buffer[FLAC__STREAM_METADATA_STREAMINFO_LENGTH];
2544 const unsigned channels1 = block->channels - 1;
2545 const unsigned bps1 = block->bits_per_sample - 1;
2547 /* we are using hardcoded numbers for simplicity but we should
2548 * probably eventually write a bit-level packer and use the
2549 * _STREAMINFO_ constants.
2551 pack_uint32_(block->min_blocksize, buffer, 2);
2552 pack_uint32_(block->max_blocksize, buffer+2, 2);
2553 pack_uint32_(block->min_framesize, buffer+4, 3);
2554 pack_uint32_(block->max_framesize, buffer+7, 3);
2555 buffer[10] = (block->sample_rate >> 12) & 0xff;
2556 buffer[11] = (block->sample_rate >> 4) & 0xff;
2557 buffer[12] = ((block->sample_rate & 0x0f) << 4) | (channels1 << 1) | (bps1 >> 4);
2558 buffer[13] = (FLAC__byte)(((bps1 & 0x0f) << 4) | ((block->total_samples >> 32) & 0x0f));
2559 pack_uint32_((FLAC__uint32)block->total_samples, buffer+14, 4);
2560 memcpy(buffer+18, block->md5sum, 16);
2562 if(write_cb(buffer, 1, FLAC__STREAM_METADATA_STREAMINFO_LENGTH, handle) != FLAC__STREAM_METADATA_STREAMINFO_LENGTH)
2568 FLAC__bool write_metadata_block_data_padding_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Padding *block, unsigned block_length)
2570 unsigned i, n = block_length;
2571 FLAC__byte buffer[1024];
2575 memset(buffer, 0, 1024);
2577 for(i = 0; i < n/1024; i++)
2578 if(write_cb(buffer, 1, 1024, handle) != 1024)
2583 if(write_cb(buffer, 1, n, handle) != n)
2589 FLAC__bool write_metadata_block_data_application_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Application *block, unsigned block_length)
2591 const unsigned id_bytes = FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8;
2593 if(write_cb(block->id, 1, id_bytes, handle) != id_bytes)
2596 block_length -= id_bytes;
2598 if(write_cb(block->data, 1, block_length, handle) != block_length)
2604 FLAC__bool write_metadata_block_data_seektable_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_SeekTable *block)
2607 FLAC__byte buffer[FLAC__STREAM_METADATA_SEEKPOINT_LENGTH];
2609 for(i = 0; i < block->num_points; i++) {
2610 /* some MAGIC NUMBERs here */
2611 pack_uint64_(block->points[i].sample_number, buffer, 8);
2612 pack_uint64_(block->points[i].stream_offset, buffer+8, 8);
2613 pack_uint32_(block->points[i].frame_samples, buffer+16, 2);
2614 if(write_cb(buffer, 1, FLAC__STREAM_METADATA_SEEKPOINT_LENGTH, handle) != FLAC__STREAM_METADATA_SEEKPOINT_LENGTH)
2621 FLAC__bool write_metadata_block_data_vorbis_comment_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_VorbisComment *block)
2624 const unsigned entry_length_len = FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN / 8;
2625 const unsigned num_comments_len = FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN / 8;
2626 FLAC__byte buffer[4]; /* magic number is asserted below */
2628 FLAC__ASSERT(max(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN, FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN) / 8 == sizeof(buffer));
2630 pack_uint32_little_endian_(block->vendor_string.length, buffer, entry_length_len);
2631 if(write_cb(buffer, 1, entry_length_len, handle) != entry_length_len)
2633 if(write_cb(block->vendor_string.entry, 1, block->vendor_string.length, handle) != block->vendor_string.length)
2636 pack_uint32_little_endian_(block->num_comments, buffer, num_comments_len);
2637 if(write_cb(buffer, 1, num_comments_len, handle) != num_comments_len)
2640 for(i = 0; i < block->num_comments; i++) {
2641 pack_uint32_little_endian_(block->comments[i].length, buffer, entry_length_len);
2642 if(write_cb(buffer, 1, entry_length_len, handle) != entry_length_len)
2644 if(write_cb(block->comments[i].entry, 1, block->comments[i].length, handle) != block->comments[i].length)
2651 FLAC__bool write_metadata_block_data_cuesheet_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_CueSheet *block)
2654 FLAC__byte buffer[1024]; /* asserted below that this is big enough */
2656 FLAC__ASSERT(sizeof(buffer) >= sizeof(FLAC__uint64));
2657 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN/8);
2658 FLAC__ASSERT(sizeof(buffer) >= (FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN + FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN)/8);
2659 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN/8);
2661 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN % 8 == 0);
2662 len = FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN / 8;
2663 if(write_cb(block->media_catalog_number, 1, len, handle) != len)
2666 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN % 8 == 0);
2667 len = FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN / 8;
2668 pack_uint64_(block->lead_in, buffer, len);
2669 if(write_cb(buffer, 1, len, handle) != len)
2672 FLAC__ASSERT((FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN + FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN) % 8 == 0);
2673 len = (FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN + FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN) / 8;
2674 memset(buffer, 0, len);
2677 if(write_cb(buffer, 1, len, handle) != len)
2680 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN % 8 == 0);
2681 len = FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN / 8;
2682 pack_uint32_(block->num_tracks, buffer, len);
2683 if(write_cb(buffer, 1, len, handle) != len)
2686 for(i = 0; i < block->num_tracks; i++) {
2687 FLAC__StreamMetadata_CueSheet_Track *track = block->tracks + i;
2689 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN % 8 == 0);
2690 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN / 8;
2691 pack_uint64_(track->offset, buffer, len);
2692 if(write_cb(buffer, 1, len, handle) != len)
2695 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN % 8 == 0);
2696 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN / 8;
2697 pack_uint32_(track->number, buffer, len);
2698 if(write_cb(buffer, 1, len, handle) != len)
2701 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN % 8 == 0);
2702 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN / 8;
2703 if(write_cb(track->isrc, 1, len, handle) != len)
2706 FLAC__ASSERT((FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN) % 8 == 0);
2707 len = (FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN + FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN) / 8;
2708 memset(buffer, 0, len);
2709 buffer[0] = (track->type << 7) | (track->pre_emphasis << 6);
2710 if(write_cb(buffer, 1, len, handle) != len)
2713 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN % 8 == 0);
2714 len = FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN / 8;
2715 pack_uint32_(track->num_indices, buffer, len);
2716 if(write_cb(buffer, 1, len, handle) != len)
2719 for(j = 0; j < track->num_indices; j++) {
2720 FLAC__StreamMetadata_CueSheet_Index *index = track->indices + j;
2722 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN % 8 == 0);
2723 len = FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN / 8;
2724 pack_uint64_(index->offset, buffer, len);
2725 if(write_cb(buffer, 1, len, handle) != len)
2728 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN % 8 == 0);
2729 len = FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN / 8;
2730 pack_uint32_(index->number, buffer, len);
2731 if(write_cb(buffer, 1, len, handle) != len)
2734 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN % 8 == 0);
2735 len = FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN / 8;
2736 memset(buffer, 0, len);
2737 if(write_cb(buffer, 1, len, handle) != len)
2745 FLAC__bool write_metadata_block_data_picture_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Picture *block)
2749 FLAC__byte buffer[4]; /* magic number is asserted below */
2751 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_TYPE_LEN%8);
2752 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_MIME_TYPE_LENGTH_LEN%8);
2753 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_DESCRIPTION_LENGTH_LEN%8);
2754 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN%8);
2755 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN%8);
2756 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN%8);
2757 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_COLORS_LEN%8);
2758 FLAC__ASSERT(0 == FLAC__STREAM_METADATA_PICTURE_DATA_LENGTH_LEN%8);
2759 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_TYPE_LEN/8);
2760 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_MIME_TYPE_LENGTH_LEN/8);
2761 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_DESCRIPTION_LENGTH_LEN/8);
2762 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN/8);
2763 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN/8);
2764 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN/8);
2765 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_COLORS_LEN/8);
2766 FLAC__ASSERT(sizeof(buffer) >= FLAC__STREAM_METADATA_PICTURE_DATA_LENGTH_LEN/8);
2768 len = FLAC__STREAM_METADATA_PICTURE_TYPE_LEN/8;
2769 pack_uint32_(block->type, buffer, len);
2770 if(write_cb(buffer, 1, len, handle) != len)
2773 len = FLAC__STREAM_METADATA_PICTURE_MIME_TYPE_LENGTH_LEN/8;
2774 slen = strlen(block->mime_type);
2775 pack_uint32_(slen, buffer, len);
2776 if(write_cb(buffer, 1, len, handle) != len)
2778 if(write_cb(block->mime_type, 1, slen, handle) != slen)
2781 len = FLAC__STREAM_METADATA_PICTURE_DESCRIPTION_LENGTH_LEN/8;
2782 slen = strlen((const char *)block->description);
2783 pack_uint32_(slen, buffer, len);
2784 if(write_cb(buffer, 1, len, handle) != len)
2786 if(write_cb(block->description, 1, slen, handle) != slen)
2789 len = FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN/8;
2790 pack_uint32_(block->width, buffer, len);
2791 if(write_cb(buffer, 1, len, handle) != len)
2794 len = FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN/8;
2795 pack_uint32_(block->height, buffer, len);
2796 if(write_cb(buffer, 1, len, handle) != len)
2799 len = FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN/8;
2800 pack_uint32_(block->depth, buffer, len);
2801 if(write_cb(buffer, 1, len, handle) != len)
2804 len = FLAC__STREAM_METADATA_PICTURE_COLORS_LEN/8;
2805 pack_uint32_(block->colors, buffer, len);
2806 if(write_cb(buffer, 1, len, handle) != len)
2809 len = FLAC__STREAM_METADATA_PICTURE_DATA_LENGTH_LEN/8;
2810 pack_uint32_(block->data_length, buffer, len);
2811 if(write_cb(buffer, 1, len, handle) != len)
2813 if(write_cb(block->data, 1, block->data_length, handle) != block->data_length)
2819 FLAC__bool write_metadata_block_data_unknown_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Write write_cb, const FLAC__StreamMetadata_Unknown *block, unsigned block_length)
2821 if(write_cb(block->data, 1, block_length, handle) != block_length)
2827 FLAC__bool write_metadata_block_stationary_(FLAC__Metadata_SimpleIterator *iterator, const FLAC__StreamMetadata *block)
2829 if(0 != fseeko(iterator->file, iterator->offset[iterator->depth], SEEK_SET)) {
2830 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
2834 if(!write_metadata_block_header_(iterator->file, &iterator->status, block))
2837 if(!write_metadata_block_data_(iterator->file, &iterator->status, block))
2840 if(0 != fseeko(iterator->file, iterator->offset[iterator->depth], SEEK_SET)) {
2841 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
2845 return read_metadata_block_header_(iterator);
2848 FLAC__bool write_metadata_block_stationary_with_padding_(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, unsigned padding_length, FLAC__bool padding_is_last)
2850 FLAC__StreamMetadata *padding;
2852 if(0 != fseeko(iterator->file, iterator->offset[iterator->depth], SEEK_SET)) {
2853 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
2857 block->is_last = false;
2859 if(!write_metadata_block_header_(iterator->file, &iterator->status, block))
2862 if(!write_metadata_block_data_(iterator->file, &iterator->status, block))
2865 if(0 == (padding = FLAC__metadata_object_new(FLAC__METADATA_TYPE_PADDING)))
2866 return FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
2868 padding->is_last = padding_is_last;
2869 padding->length = padding_length;
2871 if(!write_metadata_block_header_(iterator->file, &iterator->status, padding)) {
2872 FLAC__metadata_object_delete(padding);
2876 if(!write_metadata_block_data_(iterator->file, &iterator->status, padding)) {
2877 FLAC__metadata_object_delete(padding);
2881 FLAC__metadata_object_delete(padding);
2883 if(0 != fseeko(iterator->file, iterator->offset[iterator->depth], SEEK_SET)) {
2884 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
2888 return read_metadata_block_header_(iterator);
2891 FLAC__bool rewrite_whole_file_(FLAC__Metadata_SimpleIterator *iterator, FLAC__StreamMetadata *block, FLAC__bool append)
2895 int fixup_is_last_code = 0; /* 0 => no need to change any is_last flags */
2896 off_t fixup_is_last_flag_offset = -1;
2898 FLAC__ASSERT(0 != block || append == false);
2900 if(iterator->is_last) {
2902 fixup_is_last_code = 1; /* 1 => clear the is_last flag at the following offset */
2903 fixup_is_last_flag_offset = iterator->offset[iterator->depth];
2905 else if(0 == block) {
2906 simple_iterator_push_(iterator);
2907 if(!FLAC__metadata_simple_iterator_prev(iterator)) {
2908 (void)simple_iterator_pop_(iterator);
2911 fixup_is_last_code = -1; /* -1 => set the is_last the flag at the following offset */
2912 fixup_is_last_flag_offset = iterator->offset[iterator->depth];
2913 if(!simple_iterator_pop_(iterator))
2918 if(!simple_iterator_copy_file_prefix_(iterator, &tempfile, &tempfilename, append))
2922 if(!write_metadata_block_header_(tempfile, &iterator->status, block)) {
2923 cleanup_tempfile_(&tempfile, &tempfilename);
2927 if(!write_metadata_block_data_(tempfile, &iterator->status, block)) {
2928 cleanup_tempfile_(&tempfile, &tempfilename);
2933 if(!simple_iterator_copy_file_postfix_(iterator, &tempfile, &tempfilename, fixup_is_last_code, fixup_is_last_flag_offset, block==0))
2937 return FLAC__metadata_simple_iterator_next(iterator);
2942 void simple_iterator_push_(FLAC__Metadata_SimpleIterator *iterator)
2944 FLAC__ASSERT(iterator->depth+1 < SIMPLE_ITERATOR_MAX_PUSH_DEPTH);
2945 iterator->offset[iterator->depth+1] = iterator->offset[iterator->depth];
2949 FLAC__bool simple_iterator_pop_(FLAC__Metadata_SimpleIterator *iterator)
2951 FLAC__ASSERT(iterator->depth > 0);
2953 if(0 != fseeko(iterator->file, iterator->offset[iterator->depth], SEEK_SET)) {
2954 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
2958 return read_metadata_block_header_(iterator);
2965 * 3: not a FLAC file
2967 unsigned seek_to_first_metadata_block_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Seek seek_cb)
2969 FLAC__byte buffer[4];
2973 FLAC__ASSERT(FLAC__STREAM_SYNC_LENGTH == sizeof(buffer));
2975 /* skip any id3v2 tag */
2977 n = read_cb(buffer, 1, 4, handle);
2982 else if(0 == memcmp(buffer, "ID3", 3)) {
2983 unsigned tag_length = 0;
2985 /* skip to the tag length */
2986 if(seek_cb(handle, 2, SEEK_CUR) < 0)
2989 /* read the length */
2990 for(i = 0; i < 4; i++) {
2991 if(read_cb(buffer, 1, 1, handle) < 1 || buffer[0] & 0x80)
2994 tag_length |= (buffer[0] & 0x7f);
2997 /* skip the rest of the tag */
2998 if(seek_cb(handle, tag_length, SEEK_CUR) < 0)
3001 /* read the stream sync code */
3003 n = read_cb(buffer, 1, 4, handle);
3010 /* check for the fLaC signature */
3011 if(0 == memcmp(FLAC__STREAM_SYNC_STRING, buffer, FLAC__STREAM_SYNC_LENGTH))
3017 unsigned seek_to_first_metadata_block_(FILE *f)
3019 return seek_to_first_metadata_block_cb_((FLAC__IOHandle)f, (FLAC__IOCallback_Read)fread, fseek_wrapper_);
3022 FLAC__bool simple_iterator_copy_file_prefix_(FLAC__Metadata_SimpleIterator *iterator, FILE **tempfile, char **tempfilename, FLAC__bool append)
3024 const off_t offset_end = append? iterator->offset[iterator->depth] + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH + (off_t)iterator->length : iterator->offset[iterator->depth];
3026 if(0 != fseeko(iterator->file, 0, SEEK_SET)) {
3027 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
3030 if(!open_tempfile_(iterator->filename, iterator->tempfile_path_prefix, tempfile, tempfilename, &iterator->status)) {
3031 cleanup_tempfile_(tempfile, tempfilename);
3034 if(!copy_n_bytes_from_file_(iterator->file, *tempfile, offset_end, &iterator->status)) {
3035 cleanup_tempfile_(tempfile, tempfilename);
3042 FLAC__bool simple_iterator_copy_file_postfix_(FLAC__Metadata_SimpleIterator *iterator, FILE **tempfile, char **tempfilename, int fixup_is_last_code, off_t fixup_is_last_flag_offset, FLAC__bool backup)
3044 off_t save_offset = iterator->offset[iterator->depth];
3045 FLAC__ASSERT(0 != *tempfile);
3047 if(0 != fseeko(iterator->file, save_offset + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH + (off_t)iterator->length, SEEK_SET)) {
3048 cleanup_tempfile_(tempfile, tempfilename);
3049 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
3052 if(!copy_remaining_bytes_from_file_(iterator->file, *tempfile, &iterator->status)) {
3053 cleanup_tempfile_(tempfile, tempfilename);
3057 if(fixup_is_last_code != 0) {
3059 * if code == 1, it means a block was appended to the end so
3060 * we have to clear the is_last flag of the previous block
3061 * if code == -1, it means the last block was deleted so
3062 * we have to set the is_last flag of the previous block
3064 /* MAGIC NUMBERs here; we know the is_last flag is the high bit of the byte at this location */
3066 if(0 != fseeko(*tempfile, fixup_is_last_flag_offset, SEEK_SET)) {
3067 cleanup_tempfile_(tempfile, tempfilename);
3068 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
3071 if(fread(&x, 1, 1, *tempfile) != 1) {
3072 cleanup_tempfile_(tempfile, tempfilename);
3073 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
3076 if(fixup_is_last_code > 0) {
3077 FLAC__ASSERT(x & 0x80);
3081 FLAC__ASSERT(!(x & 0x80));
3084 if(0 != fseeko(*tempfile, fixup_is_last_flag_offset, SEEK_SET)) {
3085 cleanup_tempfile_(tempfile, tempfilename);
3086 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR;
3089 if(local__fwrite(&x, 1, 1, *tempfile) != 1) {
3090 cleanup_tempfile_(tempfile, tempfilename);
3091 iterator->status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR;
3096 (void)fclose(iterator->file);
3098 if(!transport_tempfile_(iterator->filename, tempfile, tempfilename, &iterator->status))
3101 if(iterator->has_stats)
3102 set_file_stats_(iterator->filename, &iterator->stats);
3104 if(!simple_iterator_prime_input_(iterator, !iterator->is_writable))
3107 while(iterator->offset[iterator->depth] + (off_t)FLAC__STREAM_METADATA_HEADER_LENGTH + (off_t)iterator->length < save_offset)
3108 if(!FLAC__metadata_simple_iterator_next(iterator))
3113 /* move the iterator to it's original block faster by faking a push, then doing a pop_ */
3114 FLAC__ASSERT(iterator->depth == 0);
3115 iterator->offset[0] = save_offset;
3117 return simple_iterator_pop_(iterator);
3121 FLAC__bool copy_n_bytes_from_file_(FILE *file, FILE *tempfile, off_t bytes, FLAC__Metadata_SimpleIteratorStatus *status)
3123 FLAC__byte buffer[8192];
3126 FLAC__ASSERT(bytes >= 0);
3128 n = min(sizeof(buffer), (size_t)bytes);
3129 if(fread(buffer, 1, n, file) != n) {
3130 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
3133 if(local__fwrite(buffer, 1, n, tempfile) != n) {
3134 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR;
3143 FLAC__bool copy_n_bytes_from_file_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOHandle temp_handle, FLAC__IOCallback_Write temp_write_cb, off_t bytes, FLAC__Metadata_SimpleIteratorStatus *status)
3145 FLAC__byte buffer[8192];
3148 FLAC__ASSERT(bytes >= 0);
3150 n = min(sizeof(buffer), (size_t)bytes);
3151 if(read_cb(buffer, 1, n, handle) != n) {
3152 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
3155 if(temp_write_cb(buffer, 1, n, temp_handle) != n) {
3156 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR;
3165 FLAC__bool copy_remaining_bytes_from_file_(FILE *file, FILE *tempfile, FLAC__Metadata_SimpleIteratorStatus *status)
3167 FLAC__byte buffer[8192];
3170 while(!feof(file)) {
3171 n = fread(buffer, 1, sizeof(buffer), file);
3172 if(n == 0 && !feof(file)) {
3173 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
3176 if(n > 0 && local__fwrite(buffer, 1, n, tempfile) != n) {
3177 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR;
3185 FLAC__bool copy_remaining_bytes_from_file_cb_(FLAC__IOHandle handle, FLAC__IOCallback_Read read_cb, FLAC__IOCallback_Eof eof_cb, FLAC__IOHandle temp_handle, FLAC__IOCallback_Write temp_write_cb, FLAC__Metadata_SimpleIteratorStatus *status)
3187 FLAC__byte buffer[8192];
3190 while(!eof_cb(handle)) {
3191 n = read_cb(buffer, 1, sizeof(buffer), handle);
3192 if(n == 0 && !eof_cb(handle)) {
3193 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR;
3196 if(n > 0 && temp_write_cb(buffer, 1, n, temp_handle) != n) {
3197 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR;
3205 FLAC__bool open_tempfile_(const char *filename, const char *tempfile_path_prefix, FILE **tempfile, char **tempfilename, FLAC__Metadata_SimpleIteratorStatus *status)
3207 static const char *tempfile_suffix = ".metadata_edit";
3208 if(0 == tempfile_path_prefix) {
3209 if(0 == (*tempfilename = (char*)malloc(strlen(filename) + strlen(tempfile_suffix) + 1))) {
3210 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
3213 strcpy(*tempfilename, filename);
3214 strcat(*tempfilename, tempfile_suffix);
3217 const char *p = strrchr(filename, '/');
3223 if(0 == (*tempfilename = (char*)malloc(strlen(tempfile_path_prefix) + 1 + strlen(p) + strlen(tempfile_suffix) + 1))) {
3224 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR;
3227 strcpy(*tempfilename, tempfile_path_prefix);
3228 strcat(*tempfilename, "/");
3229 strcat(*tempfilename, p);
3230 strcat(*tempfilename, tempfile_suffix);
3233 if(0 == (*tempfile = fopen(*tempfilename, "w+b"))) {
3234 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE;
3241 FLAC__bool transport_tempfile_(const char *filename, FILE **tempfile, char **tempfilename, FLAC__Metadata_SimpleIteratorStatus *status)
3243 FLAC__ASSERT(0 != filename);
3244 FLAC__ASSERT(0 != tempfile);
3245 FLAC__ASSERT(0 != *tempfile);
3246 FLAC__ASSERT(0 != tempfilename);
3247 FLAC__ASSERT(0 != *tempfilename);
3248 FLAC__ASSERT(0 != status);
3250 (void)fclose(*tempfile);
3253 #if defined _MSC_VER || defined __BORLANDC__ || defined __MINGW32__ || defined __EMX__
3254 /* on some flavors of windows, rename() will fail if the destination already exists */
3255 if(unlink(filename) < 0) {
3256 cleanup_tempfile_(tempfile, tempfilename);
3257 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR;
3262 /*@@@ to fully support the tempfile_path_prefix we need to update this piece to actually copy across filesystems instead of just rename(): */
3263 if(0 != rename(*tempfilename, filename)) {
3264 cleanup_tempfile_(tempfile, tempfilename);
3265 *status = FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR;
3269 cleanup_tempfile_(tempfile, tempfilename);
3274 void cleanup_tempfile_(FILE **tempfile, char **tempfilename)
3276 if(0 != *tempfile) {
3277 (void)fclose(*tempfile);
3281 if(0 != *tempfilename) {
3282 (void)unlink(*tempfilename);
3283 free(*tempfilename);
3288 FLAC__bool get_file_stats_(const char *filename, struct stat *stats)
3290 FLAC__ASSERT(0 != filename);
3291 FLAC__ASSERT(0 != stats);
3292 return (0 == stat(filename, stats));
3295 void set_file_stats_(const char *filename, struct stat *stats)
3297 struct utimbuf srctime;
3299 FLAC__ASSERT(0 != filename);
3300 FLAC__ASSERT(0 != stats);
3302 srctime.actime = stats->st_atime;
3303 srctime.modtime = stats->st_mtime;
3304 (void)chmod(filename, stats->st_mode);
3305 (void)utime(filename, &srctime);
3306 #if !defined _MSC_VER && !defined __BORLANDC__ && !defined __MINGW32__ && !defined __EMX__
3307 (void)chown(filename, stats->st_uid, -1);
3308 (void)chown(filename, -1, stats->st_gid);
3312 int fseek_wrapper_(FLAC__IOHandle handle, FLAC__int64 offset, int whence)
3314 return fseeko((FILE*)handle, (off_t)offset, whence);
3317 FLAC__int64 ftell_wrapper_(FLAC__IOHandle handle)
3319 return ftello((FILE*)handle);
3322 FLAC__Metadata_ChainStatus get_equivalent_status_(FLAC__Metadata_SimpleIteratorStatus status)
3325 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK:
3326 return FLAC__METADATA_CHAIN_STATUS_OK;
3327 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT:
3328 return FLAC__METADATA_CHAIN_STATUS_ILLEGAL_INPUT;
3329 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE:
3330 return FLAC__METADATA_CHAIN_STATUS_ERROR_OPENING_FILE;
3331 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE:
3332 return FLAC__METADATA_CHAIN_STATUS_NOT_A_FLAC_FILE;
3333 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE:
3334 return FLAC__METADATA_CHAIN_STATUS_NOT_WRITABLE;
3335 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA:
3336 return FLAC__METADATA_CHAIN_STATUS_BAD_METADATA;
3337 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR:
3338 return FLAC__METADATA_CHAIN_STATUS_READ_ERROR;
3339 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR:
3340 return FLAC__METADATA_CHAIN_STATUS_SEEK_ERROR;
3341 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR:
3342 return FLAC__METADATA_CHAIN_STATUS_WRITE_ERROR;
3343 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR:
3344 return FLAC__METADATA_CHAIN_STATUS_RENAME_ERROR;
3345 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR:
3346 return FLAC__METADATA_CHAIN_STATUS_UNLINK_ERROR;
3347 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR:
3348 return FLAC__METADATA_CHAIN_STATUS_MEMORY_ALLOCATION_ERROR;
3349 case FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR:
3351 return FLAC__METADATA_CHAIN_STATUS_INTERNAL_ERROR;