1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2001,2002 Josh Coalson
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
23 #include "private/metadata.h"
25 #include "FLAC/assert.h"
28 /****************************************************************************
32 ***************************************************************************/
34 static FLAC__bool copy_bytes_(FLAC__byte **to, const FLAC__byte *from, unsigned bytes)
36 if(bytes > 0 && 0 != from) {
38 if(0 == (x = malloc(bytes)))
40 memcpy(x, from, bytes);
44 FLAC__ASSERT(0 == from);
45 FLAC__ASSERT(bytes == 0);
51 static FLAC__bool copy_vcentry_(FLAC__StreamMetaData_VorbisComment_Entry *to, const FLAC__StreamMetaData_VorbisComment_Entry *from)
53 to->length = from->length;
54 if(0 == from->entry) {
55 FLAC__ASSERT(from->length == 0);
60 FLAC__ASSERT(from->length > 0);
61 if(0 == (x = malloc(from->length)))
63 memcpy(x, from->entry, from->length);
69 static void seektable_calculate_length_(FLAC__StreamMetaData *object)
71 FLAC__ASSERT(0 != object);
72 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_SEEKTABLE);
74 object->length = object->data.seek_table.num_points * FLAC__STREAM_METADATA_SEEKPOINT_LENGTH;
77 static FLAC__StreamMetaData_SeekPoint *seekpoint_array_new_(unsigned num_points)
79 FLAC__StreamMetaData_SeekPoint *object_array;
81 FLAC__ASSERT(num_points > 0);
83 object_array = malloc(num_points * sizeof(FLAC__StreamMetaData_SeekPoint));
85 if(0 != object_array) {
87 for(i = 0; i < num_points; i++) {
88 object_array[i].sample_number = FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
89 object_array[i].stream_offset = 0;
90 object_array[i].frame_samples = 0;
97 static void vorbiscomment_calculate_length_(FLAC__StreamMetaData *object)
101 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
103 object->length = (FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN) / 8;
104 object->length += object->data.vorbis_comment.vendor_string.length;
105 object->length += (FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN) / 8;
106 for(i = 0; i < object->data.vorbis_comment.num_comments; i++) {
107 object->length += (FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN / 8);
108 object->length += object->data.vorbis_comment.comments[i].length;
112 static FLAC__StreamMetaData_VorbisComment_Entry *vorbiscomment_entry_array_new_(unsigned num_comments)
114 FLAC__StreamMetaData_VorbisComment_Entry *object_array;
116 FLAC__ASSERT(num_comments > 0);
118 object_array = malloc(num_comments * sizeof(FLAC__StreamMetaData_VorbisComment_Entry));
120 if(0 != object_array)
121 memset(object_array, 0, num_comments * sizeof(FLAC__StreamMetaData_VorbisComment_Entry));
126 static void vorbiscomment_entry_array_delete_(FLAC__StreamMetaData_VorbisComment_Entry *object_array, unsigned num_comments)
130 FLAC__ASSERT(0 != object_array && num_comments > 0);
132 for(i = 0; i < num_comments; i++)
133 if(0 != object_array[i].entry)
134 free(object_array[i].entry);
136 if(0 != object_array)
140 static FLAC__StreamMetaData_VorbisComment_Entry *vorbiscomment_entry_array_copy_(const FLAC__StreamMetaData_VorbisComment_Entry *object_array, unsigned num_comments)
142 FLAC__StreamMetaData_VorbisComment_Entry *return_array;
144 FLAC__ASSERT(0 != object_array);
145 FLAC__ASSERT(num_comments > 0);
147 return_array = vorbiscomment_entry_array_new_(num_comments);
149 if(0 != return_array) {
152 /* Need to do this to set the pointers inside the comments to 0.
153 * In case of an error in the following loop, the object will be
154 * deleted and we don't want the destructor freeing uninitialized
157 memset(return_array, 0, num_comments * sizeof(FLAC__StreamMetaData_VorbisComment_Entry));
159 for(i = 0; i < num_comments; i++) {
160 if(!copy_vcentry_(return_array+i, object_array+i)) {
161 vorbiscomment_entry_array_delete_(return_array, num_comments);
170 static FLAC__bool vorbiscomment_set_entry_(FLAC__StreamMetaData *object, FLAC__StreamMetaData_VorbisComment_Entry *dest, FLAC__StreamMetaData_VorbisComment_Entry *src, FLAC__bool copy)
174 FLAC__ASSERT(0 != object);
175 FLAC__ASSERT(0 != dest);
176 FLAC__ASSERT(0 != src);
177 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
178 FLAC__ASSERT((0 != src->entry && src->length > 0) || (0 == src->entry && src->length == 0 && copy == false));
182 /* do the copy first so that if we fail we leave the object untouched */
184 if(!copy_vcentry_(dest, src))
194 vorbiscomment_calculate_length_(object);
199 /****************************************************************************
201 * Metadata object routines
203 ***************************************************************************/
206 will return pointer to new empty object of type 'type', or 0 if malloc failed
209 FLAC__StreamMetaData *FLAC__metadata_object_new(FLAC__MetaDataType type)
211 FLAC__StreamMetaData *object = malloc(sizeof(FLAC__StreamMetaData));
213 memset(object, 0, sizeof(FLAC__StreamMetaData));
214 object->is_last = false;
217 case FLAC__METADATA_TYPE_STREAMINFO:
218 object->length = FLAC__STREAM_METADATA_STREAMINFO_LENGTH;
220 case FLAC__METADATA_TYPE_PADDING:
222 case FLAC__METADATA_TYPE_APPLICATION:
223 object->length = FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8;
225 case FLAC__METADATA_TYPE_SEEKTABLE:
227 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
228 object->length = (FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN + FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN) / 8;
231 /* double protection: */
242 return a pointer to a copy of 'object', or 0 if any malloc failed. does a deep copy. user gets ownership of object.
243 FLAC__ASSERT(0 != object);
245 FLAC__StreamMetaData *FLAC__metadata_object_copy(const FLAC__StreamMetaData *object)
247 FLAC__StreamMetaData *to;
249 FLAC__ASSERT(0 != object);
251 if(0 != (to = FLAC__metadata_object_new(object->type))) {
252 to->is_last = object->is_last;
253 to->type = object->type;
254 to->length = object->length;
256 case FLAC__METADATA_TYPE_STREAMINFO:
257 memcpy(&to->data.stream_info, &object->data.stream_info, sizeof(FLAC__StreamMetaData_StreamInfo));
259 case FLAC__METADATA_TYPE_PADDING:
261 case FLAC__METADATA_TYPE_APPLICATION:
262 memcpy(&to->data.application.id, &object->data.application.id, FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8);
263 if(!copy_bytes_(&to->data.application.data, object->data.application.data, object->length - FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8)) {
264 FLAC__metadata_object_delete(to);
268 case FLAC__METADATA_TYPE_SEEKTABLE:
269 to->data.seek_table.num_points = object->data.seek_table.num_points;
270 if(!copy_bytes_((FLAC__byte**)&to->data.seek_table.points, (FLAC__byte*)object->data.seek_table.points, object->data.seek_table.num_points * sizeof(FLAC__StreamMetaData_SeekPoint))) {
271 FLAC__metadata_object_delete(to);
275 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
276 if(!copy_vcentry_(&to->data.vorbis_comment.vendor_string, &object->data.vorbis_comment.vendor_string)) {
277 FLAC__metadata_object_delete(to);
280 if(object->data.vorbis_comment.num_comments == 0) {
281 FLAC__ASSERT(0 == object->data.vorbis_comment.comments);
282 to->data.vorbis_comment.comments = 0;
285 FLAC__ASSERT(0 != object->data.vorbis_comment.comments);
286 to->data.vorbis_comment.comments = vorbiscomment_entry_array_copy_(object->data.vorbis_comment.comments, object->data.vorbis_comment.num_comments);
287 if(0 == to->data.vorbis_comment.comments) {
288 FLAC__metadata_object_delete(to);
292 to->data.vorbis_comment.num_comments = object->data.vorbis_comment.num_comments;
295 /* double protection: */
305 void FLAC__metadata_object_delete_data(FLAC__StreamMetaData *object)
307 FLAC__ASSERT(0 != object);
309 switch(object->type) {
310 case FLAC__METADATA_TYPE_STREAMINFO:
311 case FLAC__METADATA_TYPE_PADDING:
313 case FLAC__METADATA_TYPE_APPLICATION:
314 if(0 != object->data.application.data)
315 free(object->data.application.data);
317 case FLAC__METADATA_TYPE_SEEKTABLE:
318 if(0 != object->data.seek_table.points)
319 free(object->data.seek_table.points);
321 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
322 if(0 != object->data.vorbis_comment.vendor_string.entry)
323 free(object->data.vorbis_comment.vendor_string.entry);
324 if(0 != object->data.vorbis_comment.comments) {
325 FLAC__ASSERT(object->data.vorbis_comment.num_comments > 0);
326 vorbiscomment_entry_array_delete_(object->data.vorbis_comment.comments, object->data.vorbis_comment.num_comments);
335 frees 'object'. does a deep delete.
337 void FLAC__metadata_object_delete(FLAC__StreamMetaData *object)
339 FLAC__metadata_object_delete_data(object);
344 sets the application data to 'data'. if 'copy' is true, makes, copy, else takes ownership of pointer. returns false if copy==true and malloc fails.
345 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_APPLICATION);
346 FLAC__ASSERT((0 != data && length > 0) || (0 == data && length == 0 && copy == false));
348 FLAC__bool FLAC__metadata_object_application_set_data(FLAC__StreamMetaData *object, FLAC__byte *data, unsigned length, FLAC__bool copy)
352 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_APPLICATION);
353 FLAC__ASSERT((0 != data && length > 0) || (0 == data && length == 0 && copy == false));
355 save = object->data.application.data;
357 /* do the copy first so that if we fail we leave the object untouched */
359 if(!copy_bytes_(&object->data.application.data, data, length))
363 object->data.application.data = data;
369 object->length = FLAC__STREAM_METADATA_APPLICATION_ID_LEN / 8 + length;
373 FLAC__bool FLAC__metadata_object_seektable_resize_points(FLAC__StreamMetaData *object, unsigned new_num_points)
375 FLAC__ASSERT(0 != object);
376 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_SEEKTABLE);
378 if(0 == object->data.seek_table.points) {
379 FLAC__ASSERT(object->data.seek_table.num_points == 0);
380 if(0 == new_num_points)
382 else if(0 == (object->data.seek_table.points = seekpoint_array_new_(new_num_points)))
386 const unsigned old_size = object->data.seek_table.num_points * sizeof(FLAC__StreamMetaData_SeekPoint);
387 const unsigned new_size = new_num_points * sizeof(FLAC__StreamMetaData_SeekPoint);
389 FLAC__ASSERT(object->data.seek_table.num_points > 0);
392 free(object->data.seek_table.points);
393 object->data.seek_table.points = 0;
395 else if(0 == (object->data.seek_table.points = realloc(object->data.seek_table.points, new_size)))
398 /* if growing, set new elements to placeholders */
399 if(new_size > old_size) {
401 for(i = object->data.seek_table.num_points; i < new_num_points; i++) {
402 object->data.seek_table.points[i].sample_number = FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER;
403 object->data.seek_table.points[i].stream_offset = 0;
404 object->data.seek_table.points[i].frame_samples = 0;
409 object->data.seek_table.num_points = new_num_points;
411 seektable_calculate_length_(object);
415 void FLAC__metadata_object_seektable_set_point(FLAC__StreamMetaData *object, unsigned point_num, FLAC__StreamMetaData_SeekPoint point)
417 FLAC__ASSERT(0 != object);
418 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_SEEKTABLE);
419 FLAC__ASSERT(object->data.seek_table.num_points > point_num);
421 object->data.seek_table.points[point_num] = point;
424 FLAC__bool FLAC__metadata_object_seektable_insert_point(FLAC__StreamMetaData *object, unsigned point_num, FLAC__StreamMetaData_SeekPoint point)
428 FLAC__ASSERT(0 != object);
429 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
430 FLAC__ASSERT(object->data.seek_table.num_points >= point_num);
432 if(!FLAC__metadata_object_seektable_resize_points(object, object->data.seek_table.num_points+1))
435 /* move all points >= point_num forward one space */
436 for(i = (int)object->data.seek_table.num_points-1; i > (int)point_num; i--)
437 object->data.seek_table.points[i] = object->data.seek_table.points[i-1];
439 FLAC__metadata_object_seektable_set_point(object, point_num, point);
440 seektable_calculate_length_(object);
444 FLAC__bool FLAC__metadata_object_seektable_delete_point(FLAC__StreamMetaData *object, unsigned point_num)
448 FLAC__ASSERT(0 != object);
449 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_SEEKTABLE);
450 FLAC__ASSERT(object->data.seek_table.num_points > point_num);
452 /* move all points > point_num backward one space */
453 for(i = point_num; i < object->data.seek_table.num_points-1; i++)
454 object->data.seek_table.points[i] = object->data.seek_table.points[i+1];
456 return FLAC__metadata_object_seektable_resize_points(object, object->data.seek_table.num_points-1);
459 FLAC__bool FLAC__metadata_object_vorbiscomment_set_vendor_string(FLAC__StreamMetaData *object, FLAC__StreamMetaData_VorbisComment_Entry *entry, FLAC__bool copy)
461 return vorbiscomment_set_entry_(object, &object->data.vorbis_comment.vendor_string, entry, copy);
464 FLAC__bool FLAC__metadata_object_vorbiscomment_resize_comments(FLAC__StreamMetaData *object, unsigned new_num_comments)
466 FLAC__ASSERT(0 != object);
467 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
469 if(0 == object->data.vorbis_comment.comments) {
470 FLAC__ASSERT(object->data.vorbis_comment.num_comments == 0);
471 if(0 == new_num_comments)
473 else if(0 == (object->data.vorbis_comment.comments = vorbiscomment_entry_array_new_(new_num_comments)))
477 const unsigned old_size = object->data.vorbis_comment.num_comments * sizeof(FLAC__StreamMetaData_VorbisComment_Entry);
478 const unsigned new_size = new_num_comments * sizeof(FLAC__StreamMetaData_VorbisComment_Entry);
480 FLAC__ASSERT(object->data.vorbis_comment.num_comments > 0);
482 /* if shrinking, free the truncated entries */
483 if(new_num_comments < object->data.vorbis_comment.num_comments) {
485 for(i = new_num_comments; i < object->data.vorbis_comment.num_comments; i++)
486 if(0 != object->data.vorbis_comment.comments[i].entry)
487 free(object->data.vorbis_comment.comments[i].entry);
491 free(object->data.vorbis_comment.comments);
492 object->data.vorbis_comment.comments = 0;
494 else if(0 == (object->data.vorbis_comment.comments = realloc(object->data.vorbis_comment.comments, new_size)))
497 /* if growing, zero all the length/pointers of new elements */
498 if(new_size > old_size)
499 memset(object->data.vorbis_comment.comments + object->data.vorbis_comment.num_comments, 0, new_size - old_size);
502 object->data.vorbis_comment.num_comments = new_num_comments;
504 vorbiscomment_calculate_length_(object);
508 FLAC__bool FLAC__metadata_object_vorbiscomment_set_comment(FLAC__StreamMetaData *object, unsigned comment_num, FLAC__StreamMetaData_VorbisComment_Entry *entry, FLAC__bool copy)
510 return vorbiscomment_set_entry_(object, &object->data.vorbis_comment.comments[comment_num], entry, copy);
513 FLAC__bool FLAC__metadata_object_vorbiscomment_insert_comment(FLAC__StreamMetaData *object, unsigned comment_num, FLAC__StreamMetaData_VorbisComment_Entry *entry, FLAC__bool copy)
517 FLAC__ASSERT(0 != object);
518 FLAC__ASSERT(0 != entry);
519 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
520 FLAC__ASSERT(object->data.vorbis_comment.num_comments >= comment_num);
522 if(!FLAC__metadata_object_vorbiscomment_resize_comments(object, object->data.vorbis_comment.num_comments+1))
525 /* move all comments >= comment_num forward one space */
526 for(i = (int)object->data.vorbis_comment.num_comments-1; i > (int)comment_num; i--)
527 object->data.vorbis_comment.comments[i] = object->data.vorbis_comment.comments[i-1];
528 object->data.vorbis_comment.comments[i].length = 0;
529 object->data.vorbis_comment.comments[i].entry = 0;
531 return FLAC__metadata_object_vorbiscomment_set_comment(object, comment_num, entry, copy);
534 FLAC__bool FLAC__metadata_object_vorbiscomment_delete_comment(FLAC__StreamMetaData *object, unsigned comment_num)
538 FLAC__ASSERT(0 != object);
539 FLAC__ASSERT(object->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
540 FLAC__ASSERT(object->data.vorbis_comment.num_comments > comment_num);
542 /* free the comment at comment_num */
543 if(0 != object->data.vorbis_comment.comments[comment_num].entry)
544 free(object->data.vorbis_comment.comments[comment_num].entry);
546 /* move all comments > comment_num backward one space */
547 for(i = comment_num; i < object->data.vorbis_comment.num_comments-1; i++)
548 object->data.vorbis_comment.comments[i] = object->data.vorbis_comment.comments[i+1];
549 object->data.vorbis_comment.comments[i].length = 0;
550 object->data.vorbis_comment.comments[i].entry = 0;
552 return FLAC__metadata_object_vorbiscomment_resize_comments(object, object->data.vorbis_comment.num_comments-1);