Chris@0: /* Chris@0: * libid3tag - ID3 tag manipulation library Chris@0: * Copyright (C) 2000-2004 Underbit Technologies, Inc. Chris@0: * Chris@0: * This program is free software; you can redistribute it and/or modify Chris@0: * it under the terms of the GNU General Public License as published by Chris@0: * the Free Software Foundation; either version 2 of the License, or Chris@0: * (at your option) any later version. Chris@0: * Chris@0: * This program is distributed in the hope that it will be useful, Chris@0: * but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@0: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@0: * GNU General Public License for more details. Chris@0: * Chris@0: * You should have received a copy of the GNU General Public License Chris@0: * along with this program; if not, write to the Free Software Chris@0: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Chris@0: * Chris@0: * $Id: file.c,v 1.21 2004/01/23 09:41:32 rob Exp $ Chris@0: */ Chris@0: Chris@0: # ifdef HAVE_CONFIG_H Chris@0: # include "config.h" Chris@0: # endif Chris@0: Chris@0: # include "global.h" Chris@0: Chris@0: # include Chris@0: # include Chris@0: # include Chris@0: Chris@0: # ifdef HAVE_UNISTD_H Chris@0: # include Chris@0: # endif Chris@0: Chris@0: # ifdef HAVE_ASSERT_H Chris@0: # include Chris@0: # endif Chris@0: Chris@0: # include "id3tag.h" Chris@0: # include "file.h" Chris@0: # include "tag.h" Chris@0: # include "field.h" Chris@0: Chris@0: struct filetag { Chris@0: struct id3_tag *tag; Chris@0: unsigned long location; Chris@0: id3_length_t length; Chris@0: }; Chris@0: Chris@0: struct id3_file { Chris@0: FILE *iofile; Chris@0: enum id3_file_mode mode; Chris@0: char *path; Chris@0: Chris@0: int flags; Chris@0: Chris@0: struct id3_tag *primary; Chris@0: Chris@0: unsigned int ntags; Chris@0: struct filetag *tags; Chris@0: }; Chris@0: Chris@0: enum { Chris@0: ID3_FILE_FLAG_ID3V1 = 0x0001 Chris@0: }; Chris@0: Chris@0: /* Chris@0: * NAME: query_tag() Chris@0: * DESCRIPTION: check for a tag at a file's current position Chris@0: */ Chris@0: static Chris@0: signed long query_tag(FILE *iofile) Chris@0: { Chris@0: fpos_t save_position; Chris@0: id3_byte_t query[ID3_TAG_QUERYSIZE]; Chris@0: signed long size; Chris@0: Chris@0: if (fgetpos(iofile, &save_position) == -1) Chris@0: return 0; Chris@0: Chris@0: size = id3_tag_query(query, fread(query, 1, sizeof(query), iofile)); Chris@0: Chris@0: if (fsetpos(iofile, &save_position) == -1) Chris@0: return 0; Chris@0: Chris@0: return size; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: read_tag() Chris@0: * DESCRIPTION: read and parse a tag at a file's current position Chris@0: */ Chris@0: static Chris@0: struct id3_tag *read_tag(FILE *iofile, id3_length_t size) Chris@0: { Chris@0: id3_byte_t *data; Chris@0: struct id3_tag *tag = 0; Chris@0: Chris@0: data = malloc(size); Chris@0: if (data) { Chris@0: if (fread(data, size, 1, iofile) == 1) Chris@0: tag = id3_tag_parse(data, size); Chris@0: Chris@0: free(data); Chris@0: } Chris@0: Chris@0: return tag; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: update_primary() Chris@0: * DESCRIPTION: update the primary tag with data from a new tag Chris@0: */ Chris@0: static Chris@0: int update_primary(struct id3_tag *tag, struct id3_tag const *new) Chris@0: { Chris@0: unsigned int i; Chris@0: struct id3_frame *frame; Chris@0: Chris@0: if (new) { Chris@0: if (!(new->extendedflags & ID3_TAG_EXTENDEDFLAG_TAGISANUPDATE)) Chris@0: id3_tag_clearframes(tag); Chris@0: Chris@0: i = 0; Chris@0: while ((frame = id3_tag_findframe(new, 0, i++))) { Chris@0: if (id3_tag_attachframe(tag, frame) == -1) Chris@0: return -1; Chris@0: } Chris@0: } Chris@0: Chris@0: return 0; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: tag_compare() Chris@0: * DESCRIPTION: tag sort function for qsort() Chris@0: */ Chris@0: static Chris@0: int tag_compare(const void *a, const void *b) Chris@0: { Chris@0: struct filetag const *tag1 = a, *tag2 = b; Chris@0: Chris@0: if (tag1->location < tag2->location) Chris@0: return -1; Chris@0: else if (tag1->location > tag2->location) Chris@0: return +1; Chris@0: Chris@0: return 0; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: add_filetag() Chris@0: * DESCRIPTION: add a new file tag entry Chris@0: */ Chris@0: static Chris@0: int add_filetag(struct id3_file *file, struct filetag const *filetag) Chris@0: { Chris@0: struct filetag *tags; Chris@0: Chris@0: tags = realloc(file->tags, (file->ntags + 1) * sizeof(*tags)); Chris@0: if (tags == 0) Chris@0: return -1; Chris@0: Chris@0: file->tags = tags; Chris@0: file->tags[file->ntags++] = *filetag; Chris@0: Chris@0: /* sort tags by location */ Chris@0: Chris@0: if (file->ntags > 1) Chris@0: qsort(file->tags, file->ntags, sizeof(file->tags[0]), tag_compare); Chris@0: Chris@0: return 0; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: del_filetag() Chris@0: * DESCRIPTION: delete a file tag entry Chris@0: */ Chris@0: static Chris@0: void del_filetag(struct id3_file *file, unsigned int index) Chris@0: { Chris@0: assert(index < file->ntags); Chris@0: Chris@0: while (index < file->ntags - 1) { Chris@0: file->tags[index] = file->tags[index + 1]; Chris@0: ++index; Chris@0: } Chris@0: Chris@0: --file->ntags; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: add_tag() Chris@0: * DESCRIPTION: read, parse, and add a tag to a file structure Chris@0: */ Chris@0: static Chris@0: struct id3_tag *add_tag(struct id3_file *file, id3_length_t length) Chris@0: { Chris@0: long location; Chris@0: unsigned int i; Chris@0: struct filetag filetag; Chris@0: struct id3_tag *tag; Chris@0: Chris@0: location = ftell(file->iofile); Chris@0: if (location == -1) Chris@0: return 0; Chris@0: Chris@0: /* check for duplication/overlap */ Chris@0: { Chris@0: unsigned long begin1, end1, begin2, end2; Chris@0: Chris@0: begin1 = location; Chris@0: end1 = begin1 + length; Chris@0: Chris@0: for (i = 0; i < file->ntags; ++i) { Chris@0: begin2 = file->tags[i].location; Chris@0: end2 = begin2 + file->tags[i].length; Chris@0: Chris@0: if (begin1 == begin2 && end1 == end2) Chris@0: return file->tags[i].tag; /* duplicate */ Chris@0: Chris@0: if (begin1 < end2 && end1 > begin2) Chris@0: return 0; /* overlap */ Chris@0: } Chris@0: } Chris@0: Chris@0: tag = read_tag(file->iofile, length); Chris@0: Chris@0: filetag.tag = tag; Chris@0: filetag.location = location; Chris@0: filetag.length = length; Chris@0: Chris@0: if (add_filetag(file, &filetag) == -1 || Chris@0: update_primary(file->primary, tag) == -1) { Chris@0: if (tag) Chris@0: id3_tag_delete(tag); Chris@0: return 0; Chris@0: } Chris@0: Chris@0: if (tag) Chris@0: id3_tag_addref(tag); Chris@0: Chris@0: return tag; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: search_tags() Chris@0: * DESCRIPTION: search for tags in a file Chris@0: */ Chris@0: static Chris@0: int search_tags(struct id3_file *file) Chris@0: { Chris@0: fpos_t save_position; Chris@0: signed long size; Chris@0: Chris@0: /* Chris@0: * save the current seek position Chris@0: * Chris@0: * We also verify the stream is seekable by calling fsetpos(), since Chris@0: * fgetpos() alone is not reliable enough for this purpose. Chris@0: * Chris@0: * [Apparently not even fsetpos() is sufficient under Win32.] Chris@0: */ Chris@0: Chris@0: if (fgetpos(file->iofile, &save_position) == -1 || Chris@0: fsetpos(file->iofile, &save_position) == -1) Chris@0: return -1; Chris@0: Chris@0: /* look for an ID3v1 tag */ Chris@0: Chris@0: if (fseek(file->iofile, -128, SEEK_END) == 0) { Chris@0: size = query_tag(file->iofile); Chris@0: if (size > 0) { Chris@0: struct id3_tag const *tag; Chris@0: Chris@0: tag = add_tag(file, size); Chris@0: Chris@0: /* if this is indeed an ID3v1 tag, mark the file so */ Chris@0: Chris@0: if (tag && (ID3_TAG_VERSION_MAJOR(id3_tag_version(tag)) == 1)) Chris@0: file->flags |= ID3_FILE_FLAG_ID3V1; Chris@0: } Chris@0: } Chris@0: Chris@0: /* look for a tag at the beginning of the file */ Chris@0: Chris@0: rewind(file->iofile); Chris@0: Chris@0: size = query_tag(file->iofile); Chris@0: if (size > 0) { Chris@0: struct id3_tag const *tag; Chris@0: struct id3_frame const *frame; Chris@0: Chris@0: tag = add_tag(file, size); Chris@0: Chris@0: /* locate tags indicated by SEEK frames */ Chris@0: Chris@0: while (tag && (frame = id3_tag_findframe(tag, "SEEK", 0))) { Chris@0: long seek; Chris@0: Chris@0: seek = id3_field_getint(id3_frame_field(frame, 0)); Chris@0: if (seek < 0 || fseek(file->iofile, seek, SEEK_CUR) == -1) Chris@0: break; Chris@0: Chris@0: size = query_tag(file->iofile); Chris@0: tag = (size > 0) ? add_tag(file, size) : 0; Chris@0: } Chris@0: } Chris@0: Chris@0: /* look for a tag at the end of the file (before any ID3v1 tag) */ Chris@0: Chris@0: if (fseek(file->iofile, ((file->flags & ID3_FILE_FLAG_ID3V1) ? -128 : 0) + Chris@0: -10, SEEK_END) == 0) { Chris@0: size = query_tag(file->iofile); Chris@0: if (size < 0 && fseek(file->iofile, size, SEEK_CUR) == 0) { Chris@0: size = query_tag(file->iofile); Chris@0: if (size > 0) Chris@0: add_tag(file, size); Chris@0: } Chris@0: } Chris@0: Chris@0: clearerr(file->iofile); Chris@0: Chris@0: /* restore seek position */ Chris@0: Chris@0: if (fsetpos(file->iofile, &save_position) == -1) Chris@0: return -1; Chris@0: Chris@0: /* set primary tag options and target padded length for convenience */ Chris@0: Chris@0: if ((file->ntags > 0 && !(file->flags & ID3_FILE_FLAG_ID3V1)) || Chris@0: (file->ntags > 1 && (file->flags & ID3_FILE_FLAG_ID3V1))) { Chris@0: if (file->tags[0].location == 0) Chris@0: id3_tag_setlength(file->primary, file->tags[0].length); Chris@0: else Chris@0: id3_tag_options(file->primary, ID3_TAG_OPTION_APPENDEDTAG, ~0); Chris@0: } Chris@0: Chris@0: return 0; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: finish_file() Chris@0: * DESCRIPTION: release memory associated with a file Chris@0: */ Chris@0: static Chris@0: void finish_file(struct id3_file *file) Chris@0: { Chris@0: unsigned int i; Chris@0: Chris@0: if (file->path) Chris@0: free(file->path); Chris@0: Chris@0: if (file->primary) { Chris@0: id3_tag_delref(file->primary); Chris@0: id3_tag_delete(file->primary); Chris@0: } Chris@0: Chris@0: for (i = 0; i < file->ntags; ++i) { Chris@0: struct id3_tag *tag; Chris@0: Chris@0: tag = file->tags[i].tag; Chris@0: if (tag) { Chris@0: id3_tag_delref(tag); Chris@0: id3_tag_delete(tag); Chris@0: } Chris@0: } Chris@0: Chris@0: if (file->tags) Chris@0: free(file->tags); Chris@0: Chris@0: free(file); Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: new_file() Chris@0: * DESCRIPTION: create a new file structure and load tags Chris@0: */ Chris@0: static Chris@0: struct id3_file *new_file(FILE *iofile, enum id3_file_mode mode, Chris@0: char const *path) Chris@0: { Chris@0: struct id3_file *file; Chris@0: Chris@0: file = malloc(sizeof(*file)); Chris@0: if (file == 0) Chris@0: goto fail; Chris@0: Chris@0: file->iofile = iofile; Chris@0: file->mode = mode; Chris@0: file->path = path ? strdup(path) : 0; Chris@0: Chris@0: file->flags = 0; Chris@0: Chris@0: file->ntags = 0; Chris@0: file->tags = 0; Chris@0: Chris@0: file->primary = id3_tag_new(); Chris@0: if (file->primary == 0) Chris@0: goto fail; Chris@0: Chris@0: id3_tag_addref(file->primary); Chris@0: Chris@0: /* load tags from the file */ Chris@0: Chris@0: if (search_tags(file) == -1) Chris@0: goto fail; Chris@0: Chris@0: id3_tag_options(file->primary, ID3_TAG_OPTION_ID3V1, Chris@0: (file->flags & ID3_FILE_FLAG_ID3V1) ? ~0 : 0); Chris@0: Chris@0: if (0) { Chris@0: fail: Chris@0: if (file) { Chris@0: finish_file(file); Chris@0: file = 0; Chris@0: } Chris@0: } Chris@0: Chris@0: return file; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: file->open() Chris@0: * DESCRIPTION: open a file given its pathname Chris@0: */ Chris@0: struct id3_file *id3_file_open(char const *path, enum id3_file_mode mode) Chris@0: { Chris@0: FILE *iofile; Chris@0: struct id3_file *file; Chris@0: Chris@0: assert(path); Chris@0: Chris@0: iofile = fopen(path, (mode == ID3_FILE_MODE_READWRITE) ? "r+b" : "rb"); Chris@0: if (iofile == 0) Chris@0: return 0; Chris@0: Chris@0: file = new_file(iofile, mode, path); Chris@0: if (file == 0) Chris@0: fclose(iofile); Chris@0: Chris@0: return file; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: file->fdopen() Chris@0: * DESCRIPTION: open a file using an existing file descriptor Chris@0: */ Chris@0: struct id3_file *id3_file_fdopen(int fd, enum id3_file_mode mode) Chris@0: { Chris@0: # if 1 || defined(HAVE_UNISTD_H) Chris@0: FILE *iofile; Chris@0: struct id3_file *file; Chris@0: Chris@0: iofile = fdopen(fd, (mode == ID3_FILE_MODE_READWRITE) ? "r+b" : "rb"); Chris@0: if (iofile == 0) Chris@0: return 0; Chris@0: Chris@0: file = new_file(iofile, mode, 0); Chris@0: if (file == 0) { Chris@0: int save_fd; Chris@0: Chris@0: /* close iofile without closing fd */ Chris@0: Chris@0: save_fd = dup(fd); Chris@0: Chris@0: fclose(iofile); Chris@0: Chris@0: dup2(save_fd, fd); Chris@0: close(save_fd); Chris@0: } Chris@0: Chris@0: return file; Chris@0: # else Chris@0: return 0; Chris@0: # endif Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: file->close() Chris@0: * DESCRIPTION: close a file and delete its associated tags Chris@0: */ Chris@0: int id3_file_close(struct id3_file *file) Chris@0: { Chris@0: int result = 0; Chris@0: Chris@0: assert(file); Chris@0: Chris@0: if (fclose(file->iofile) == EOF) Chris@0: result = -1; Chris@0: Chris@0: finish_file(file); Chris@0: Chris@0: return result; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: file->tag() Chris@0: * DESCRIPTION: return the primary tag structure for a file Chris@0: */ Chris@0: struct id3_tag *id3_file_tag(struct id3_file const *file) Chris@0: { Chris@0: assert(file); Chris@0: Chris@0: return file->primary; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: v1_write() Chris@0: * DESCRIPTION: write ID3v1 tag modifications to a file Chris@0: */ Chris@0: static Chris@0: int v1_write(struct id3_file *file, Chris@0: id3_byte_t const *data, id3_length_t length) Chris@0: { Chris@0: assert(!data || length == 128); Chris@0: Chris@0: if (data) { Chris@0: long location; Chris@0: Chris@0: if (fseek(file->iofile, (file->flags & ID3_FILE_FLAG_ID3V1) ? -128 : 0, Chris@0: SEEK_END) == -1 || Chris@0: (location = ftell(file->iofile)) == -1 || Chris@0: fwrite(data, 128, 1, file->iofile) != 1 || Chris@0: fflush(file->iofile) == EOF) Chris@0: return -1; Chris@0: Chris@0: /* add file tag reference */ Chris@0: Chris@0: if (!(file->flags & ID3_FILE_FLAG_ID3V1)) { Chris@0: struct filetag filetag; Chris@0: Chris@0: filetag.tag = 0; Chris@0: filetag.location = location; Chris@0: filetag.length = 128; Chris@0: Chris@0: if (add_filetag(file, &filetag) == -1) Chris@0: return -1; Chris@0: Chris@0: file->flags |= ID3_FILE_FLAG_ID3V1; Chris@0: } Chris@0: } Chris@0: # if defined(HAVE_FTRUNCATE) Chris@0: else if (file->flags & ID3_FILE_FLAG_ID3V1) { Chris@0: long length; Chris@0: Chris@0: if (fseek(file->iofile, 0, SEEK_END) == -1) Chris@0: return -1; Chris@0: Chris@0: length = ftell(file->iofile); Chris@0: if (length == -1 || Chris@0: (length >= 0 && length < 128)) Chris@0: return -1; Chris@0: Chris@0: if (ftruncate(fileno(file->iofile), length - 128) == -1) Chris@0: return -1; Chris@0: Chris@0: /* delete file tag reference */ Chris@0: Chris@0: del_filetag(file, file->ntags - 1); Chris@0: Chris@0: file->flags &= ~ID3_FILE_FLAG_ID3V1; Chris@0: } Chris@0: # endif Chris@0: Chris@0: return 0; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: v2_write() Chris@0: * DESCRIPTION: write ID3v2 tag modifications to a file Chris@0: */ Chris@0: static Chris@0: int v2_write(struct id3_file *file, Chris@0: id3_byte_t const *data, id3_length_t length) Chris@0: { Chris@0: assert(!data || length > 0); Chris@0: Chris@0: if (data && Chris@0: ((file->ntags == 1 && !(file->flags & ID3_FILE_FLAG_ID3V1)) || Chris@0: (file->ntags == 2 && (file->flags & ID3_FILE_FLAG_ID3V1))) && Chris@0: file->tags[0].length == length) { Chris@0: /* easy special case: rewrite existing tag in-place */ Chris@0: Chris@0: if (fseek(file->iofile, file->tags[0].location, SEEK_SET) == -1 || Chris@0: fwrite(data, length, 1, file->iofile) != 1 || Chris@0: fflush(file->iofile) == EOF) Chris@0: return -1; Chris@0: Chris@0: goto done; Chris@0: } Chris@0: Chris@0: /* hard general case: rewrite entire file */ Chris@0: Chris@0: /* ... */ Chris@0: Chris@0: done: Chris@0: return 0; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: file->update() Chris@0: * DESCRIPTION: rewrite tag(s) to a file Chris@0: */ Chris@0: int id3_file_update(struct id3_file *file) Chris@0: { Chris@0: int options, result = 0; Chris@0: id3_length_t v1size = 0, v2size = 0; Chris@0: id3_byte_t id3v1_data[128], *id3v1 = 0, *id3v2 = 0; Chris@0: Chris@0: assert(file); Chris@0: Chris@0: if (file->mode != ID3_FILE_MODE_READWRITE) Chris@0: return -1; Chris@0: Chris@0: options = id3_tag_options(file->primary, 0, 0); Chris@0: Chris@0: /* render ID3v1 */ Chris@0: Chris@0: if (options & ID3_TAG_OPTION_ID3V1) { Chris@0: v1size = id3_tag_render(file->primary, 0); Chris@0: if (v1size) { Chris@0: assert(v1size == sizeof(id3v1_data)); Chris@0: Chris@0: v1size = id3_tag_render(file->primary, id3v1_data); Chris@0: if (v1size) { Chris@0: assert(v1size == sizeof(id3v1_data)); Chris@0: id3v1 = id3v1_data; Chris@0: } Chris@0: } Chris@0: } Chris@0: Chris@0: /* render ID3v2 */ Chris@0: Chris@0: id3_tag_options(file->primary, ID3_TAG_OPTION_ID3V1, 0); Chris@0: Chris@0: v2size = id3_tag_render(file->primary, 0); Chris@0: if (v2size) { Chris@0: id3v2 = malloc(v2size); Chris@0: if (id3v2 == 0) Chris@0: goto fail; Chris@0: Chris@0: v2size = id3_tag_render(file->primary, id3v2); Chris@0: if (v2size == 0) { Chris@0: free(id3v2); Chris@0: id3v2 = 0; Chris@0: } Chris@0: } Chris@0: Chris@0: /* write tags */ Chris@0: Chris@0: if (v2_write(file, id3v2, v2size) == -1 || Chris@0: v1_write(file, id3v1, v1size) == -1) Chris@0: goto fail; Chris@0: Chris@0: rewind(file->iofile); Chris@0: Chris@0: /* update file tags array? ... */ Chris@0: Chris@0: if (0) { Chris@0: fail: Chris@0: result = -1; Chris@0: } Chris@0: Chris@0: /* clean up; restore tag options */ Chris@0: Chris@0: if (id3v2) Chris@0: free(id3v2); Chris@0: Chris@0: id3_tag_options(file->primary, ~0, options); Chris@0: Chris@0: return result; Chris@0: }