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: frame.c,v 1.15 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: Chris@0: # ifdef HAVE_ASSERT_H Chris@0: # include Chris@0: # endif Chris@0: Chris@0: # include "id3tag.h" Chris@0: # include "frame.h" Chris@0: # include "frametype.h" Chris@0: # include "compat.h" Chris@0: # include "field.h" Chris@0: # include "render.h" Chris@0: # include "parse.h" Chris@0: # include "util.h" Chris@0: Chris@0: static Chris@0: int valid_idchar(char c) Chris@0: { Chris@0: return (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9'); Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: frame->validid() Chris@0: * DESCRIPTION: return true if the parameter string is a legal frame ID Chris@0: */ Chris@0: int id3_frame_validid(char const *id) Chris@0: { Chris@0: return id && Chris@0: valid_idchar(id[0]) && Chris@0: valid_idchar(id[1]) && Chris@0: valid_idchar(id[2]) && Chris@0: valid_idchar(id[3]); Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: frame->new() Chris@0: * DESCRIPTION: allocate and return a new frame Chris@0: */ Chris@0: struct id3_frame *id3_frame_new(char const *id) Chris@0: { Chris@0: struct id3_frametype const *frametype; Chris@0: struct id3_frame *frame; Chris@0: unsigned int i; Chris@0: Chris@0: if (!id3_frame_validid(id)) Chris@0: return 0; Chris@0: Chris@0: frametype = id3_frametype_lookup(id, 4); Chris@0: if (frametype == 0) { Chris@0: switch (id[0]) { Chris@0: case 'T': Chris@0: frametype = &id3_frametype_text; Chris@0: break; Chris@0: Chris@0: case 'W': Chris@0: frametype = &id3_frametype_url; Chris@0: break; Chris@0: Chris@0: case 'X': Chris@0: case 'Y': Chris@0: case 'Z': Chris@0: frametype = &id3_frametype_experimental; Chris@0: break; Chris@0: Chris@0: default: Chris@0: frametype = &id3_frametype_unknown; Chris@0: if (id3_compat_lookup(id, 4)) Chris@0: frametype = &id3_frametype_obsolete; Chris@0: break; Chris@0: } Chris@0: } Chris@0: Chris@0: frame = malloc(sizeof(*frame) + frametype->nfields * sizeof(*frame->fields)); Chris@0: if (frame) { Chris@0: frame->id[0] = id[0]; Chris@0: frame->id[1] = id[1]; Chris@0: frame->id[2] = id[2]; Chris@0: frame->id[3] = id[3]; Chris@0: frame->id[4] = 0; Chris@0: Chris@0: frame->description = frametype->description; Chris@0: frame->refcount = 0; Chris@0: frame->flags = frametype->defaultflags; Chris@0: frame->group_id = 0; Chris@0: frame->encryption_method = 0; Chris@0: frame->encoded = 0; Chris@0: frame->encoded_length = 0; Chris@0: frame->decoded_length = 0; Chris@0: frame->nfields = frametype->nfields; Chris@0: frame->fields = (union id3_field *) &frame[1]; Chris@0: Chris@0: for (i = 0; i < frame->nfields; ++i) Chris@0: id3_field_init(&frame->fields[i], frametype->fields[i]); Chris@0: } Chris@0: Chris@0: return frame; Chris@0: } Chris@0: Chris@0: void id3_frame_delete(struct id3_frame *frame) Chris@0: { Chris@0: assert(frame); Chris@0: Chris@0: if (frame->refcount == 0) { Chris@0: unsigned int i; Chris@0: Chris@0: for (i = 0; i < frame->nfields; ++i) Chris@0: id3_field_finish(&frame->fields[i]); Chris@0: Chris@0: if (frame->encoded) Chris@0: free(frame->encoded); Chris@0: Chris@0: free(frame); Chris@0: } Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: frame->addref() Chris@0: * DESCRIPTION: add an external reference to a frame Chris@0: */ Chris@0: void id3_frame_addref(struct id3_frame *frame) Chris@0: { Chris@0: assert(frame); Chris@0: Chris@0: ++frame->refcount; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: frame->delref() Chris@0: * DESCRIPTION: remove an external reference to a frame Chris@0: */ Chris@0: void id3_frame_delref(struct id3_frame *frame) Chris@0: { Chris@0: assert(frame && frame->refcount > 0); Chris@0: Chris@0: --frame->refcount; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: frame->field() Chris@0: * DESCRIPTION: return a pointer to a field in a frame Chris@0: */ Chris@0: union id3_field *id3_frame_field(struct id3_frame const *frame, Chris@0: unsigned int index) Chris@0: { Chris@0: assert(frame); Chris@0: Chris@0: return (index < frame->nfields) ? &frame->fields[index] : 0; Chris@0: } Chris@0: Chris@0: static Chris@0: struct id3_frame *obsolete(char const *id, id3_byte_t const *data, Chris@0: id3_length_t length) Chris@0: { Chris@0: struct id3_frame *frame; Chris@0: Chris@0: frame = id3_frame_new(ID3_FRAME_OBSOLETE); Chris@0: if (frame) { Chris@0: if (id3_field_setframeid(&frame->fields[0], id) == -1 || Chris@0: id3_field_setbinarydata(&frame->fields[1], data, length) == -1) Chris@0: goto fail; Chris@0: } Chris@0: Chris@0: if (0) { Chris@0: fail: Chris@0: if (frame) { Chris@0: id3_frame_delete(frame); Chris@0: frame = 0; Chris@0: } Chris@0: } Chris@0: Chris@0: return frame; Chris@0: } Chris@0: Chris@0: static Chris@0: struct id3_frame *unparseable(char const *id, id3_byte_t const **ptr, Chris@0: id3_length_t length, int flags, Chris@0: int group_id, int encryption_method, Chris@0: id3_length_t decoded_length) Chris@0: { Chris@0: struct id3_frame *frame = 0; Chris@0: id3_byte_t *mem; Chris@0: Chris@0: mem = malloc(length ? length : 1); Chris@0: if (mem == 0) Chris@0: goto fail; Chris@0: Chris@0: frame = id3_frame_new(id); Chris@0: if (frame == 0) Chris@0: free(mem); Chris@0: else { Chris@0: memcpy(mem, *ptr, length); Chris@0: Chris@0: frame->flags = flags; Chris@0: frame->group_id = group_id; Chris@0: frame->encryption_method = encryption_method; Chris@0: frame->encoded = mem; Chris@0: frame->encoded_length = length; Chris@0: frame->decoded_length = decoded_length; Chris@0: } Chris@0: Chris@0: if (0) { Chris@0: fail: Chris@0: ; Chris@0: } Chris@0: Chris@0: *ptr += length; Chris@0: Chris@0: return frame; Chris@0: } Chris@0: Chris@0: static Chris@0: int parse_data(struct id3_frame *frame, Chris@0: id3_byte_t const *data, id3_length_t length) Chris@0: { Chris@0: enum id3_field_textencoding encoding; Chris@0: id3_byte_t const *end; Chris@0: unsigned int i; Chris@0: Chris@0: encoding = ID3_FIELD_TEXTENCODING_ISO_8859_1; Chris@0: Chris@0: end = data + length; Chris@0: Chris@0: for (i = 0; i < frame->nfields; ++i) { Chris@0: if (id3_field_parse(&frame->fields[i], &data, end - data, &encoding) == -1) Chris@0: return -1; Chris@0: } Chris@0: Chris@0: return 0; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: frame->parse() Chris@0: * DESCRIPTION: parse raw frame data according to the specified ID3 tag version Chris@0: */ Chris@0: struct id3_frame *id3_frame_parse(id3_byte_t const **ptr, id3_length_t length, Chris@0: unsigned int version) Chris@0: { Chris@0: struct id3_frame *frame = 0; Chris@0: id3_byte_t const *id, *end, *data; Chris@0: id3_length_t size, decoded_length = 0; Chris@0: int flags = 0, group_id = 0, encryption_method = 0; Chris@0: struct id3_compat const *compat = 0; Chris@0: id3_byte_t *mem = 0; Chris@0: char xid[4]; Chris@0: Chris@0: id = *ptr; Chris@0: end = *ptr + length; Chris@0: Chris@0: if (ID3_TAG_VERSION_MAJOR(version) < 4) { Chris@0: switch (ID3_TAG_VERSION_MAJOR(version)) { Chris@0: case 2: Chris@0: if (length < 6) Chris@0: goto fail; Chris@0: Chris@0: compat = id3_compat_lookup(id, 3); Chris@0: Chris@0: *ptr += 3; Chris@0: size = id3_parse_uint(ptr, 3); Chris@0: Chris@0: if (size > end - *ptr) Chris@0: goto fail; Chris@0: Chris@0: end = *ptr + size; Chris@0: Chris@0: break; Chris@0: Chris@0: case 3: Chris@0: if (length < 10) Chris@0: goto fail; Chris@0: Chris@0: compat = id3_compat_lookup(id, 4); Chris@0: Chris@0: *ptr += 4; Chris@0: size = id3_parse_uint(ptr, 4); Chris@0: flags = id3_parse_uint(ptr, 2); Chris@0: Chris@0: if (size > end - *ptr) Chris@0: goto fail; Chris@0: Chris@0: end = *ptr + size; Chris@0: Chris@0: if (flags & (ID3_FRAME_FLAG_FORMATFLAGS & ~0x00e0)) { Chris@0: frame = unparseable(id, ptr, end - *ptr, 0, 0, 0, 0); Chris@0: goto done; Chris@0: } Chris@0: Chris@0: flags = Chris@0: ((flags >> 1) & ID3_FRAME_FLAG_STATUSFLAGS) | Chris@0: ((flags >> 4) & (ID3_FRAME_FLAG_COMPRESSION | Chris@0: ID3_FRAME_FLAG_ENCRYPTION)) | Chris@0: ((flags << 1) & ID3_FRAME_FLAG_GROUPINGIDENTITY); Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_COMPRESSION) { Chris@0: if (end - *ptr < 4) Chris@0: goto fail; Chris@0: Chris@0: decoded_length = id3_parse_uint(ptr, 4); Chris@0: } Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_ENCRYPTION) { Chris@0: if (end - *ptr < 1) Chris@0: goto fail; Chris@0: Chris@0: encryption_method = id3_parse_uint(ptr, 1); Chris@0: } Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_GROUPINGIDENTITY) { Chris@0: if (end - *ptr < 1) Chris@0: goto fail; Chris@0: Chris@0: group_id = id3_parse_uint(ptr, 1); Chris@0: } Chris@0: Chris@0: break; Chris@0: Chris@0: default: Chris@0: goto fail; Chris@0: } Chris@0: Chris@0: /* canonicalize frame ID for ID3v2.4 */ Chris@0: Chris@0: if (compat && compat->equiv) Chris@0: id = compat->equiv; Chris@0: else if (ID3_TAG_VERSION_MAJOR(version) == 2) { Chris@0: xid[0] = 'Y'; Chris@0: xid[1] = id[0]; Chris@0: xid[2] = id[1]; Chris@0: xid[3] = id[2]; Chris@0: Chris@0: id = xid; Chris@0: Chris@0: flags |= Chris@0: ID3_FRAME_FLAG_TAGALTERPRESERVATION | Chris@0: ID3_FRAME_FLAG_FILEALTERPRESERVATION; Chris@0: } Chris@0: } Chris@0: else { /* ID3v2.4 */ Chris@0: if (length < 10) Chris@0: goto fail; Chris@0: Chris@0: *ptr += 4; Chris@0: size = id3_parse_syncsafe(ptr, 4); Chris@0: flags = id3_parse_uint(ptr, 2); Chris@0: Chris@0: if (size > end - *ptr) Chris@0: goto fail; Chris@0: Chris@0: end = *ptr + size; Chris@0: Chris@0: if (flags & (ID3_FRAME_FLAG_FORMATFLAGS & ~ID3_FRAME_FLAG_KNOWNFLAGS)) { Chris@0: frame = unparseable(id, ptr, end - *ptr, flags, 0, 0, 0); Chris@0: goto done; Chris@0: } Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_GROUPINGIDENTITY) { Chris@0: if (end - *ptr < 1) Chris@0: goto fail; Chris@0: Chris@0: group_id = id3_parse_uint(ptr, 1); Chris@0: } Chris@0: Chris@0: if ((flags & ID3_FRAME_FLAG_COMPRESSION) && Chris@0: !(flags & ID3_FRAME_FLAG_DATALENGTHINDICATOR)) Chris@0: goto fail; Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_ENCRYPTION) { Chris@0: if (end - *ptr < 1) Chris@0: goto fail; Chris@0: Chris@0: encryption_method = id3_parse_uint(ptr, 1); Chris@0: } Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_DATALENGTHINDICATOR) { Chris@0: if (end - *ptr < 4) Chris@0: goto fail; Chris@0: Chris@0: decoded_length = id3_parse_syncsafe(ptr, 4); Chris@0: } Chris@0: } Chris@0: Chris@0: data = *ptr; Chris@0: *ptr = end; Chris@0: Chris@0: /* undo frame encodings */ Chris@0: Chris@0: if ((flags & ID3_FRAME_FLAG_UNSYNCHRONISATION) && end - data > 0) { Chris@0: mem = malloc(end - data); Chris@0: if (mem == 0) Chris@0: goto fail; Chris@0: Chris@0: memcpy(mem, data, end - data); Chris@0: Chris@0: end = mem + id3_util_deunsynchronise(mem, end - data); Chris@0: data = mem; Chris@0: } Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_ENCRYPTION) { Chris@0: frame = unparseable(id, &data, end - data, flags, Chris@0: group_id, encryption_method, decoded_length); Chris@0: goto done; Chris@0: } Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_COMPRESSION) { Chris@0: id3_byte_t *decomp; Chris@0: Chris@0: decomp = id3_util_decompress(data, end - data, decoded_length); Chris@0: if (decomp == 0) Chris@0: goto fail; Chris@0: Chris@0: if (mem) Chris@0: free(mem); Chris@0: Chris@0: data = mem = decomp; Chris@0: end = data + decoded_length; Chris@0: } Chris@0: Chris@0: /* check for obsolescence */ Chris@0: Chris@0: if (compat && !compat->equiv) { Chris@0: frame = obsolete(id, data, end - data); Chris@0: goto done; Chris@0: } Chris@0: Chris@0: /* generate the internal frame structure */ Chris@0: Chris@0: frame = id3_frame_new(id); Chris@0: if (frame) { Chris@0: frame->flags = flags; Chris@0: frame->group_id = group_id; Chris@0: Chris@0: if (compat && compat->translate) { Chris@0: if (compat->translate(frame, compat->id, data, end - data) == -1) Chris@0: goto fail; Chris@0: } Chris@0: else { Chris@0: if (parse_data(frame, data, end - data) == -1) Chris@0: goto fail; Chris@0: } Chris@0: } Chris@0: Chris@0: if (0) { Chris@0: fail: Chris@0: if (frame) { Chris@0: id3_frame_delete(frame); Chris@0: frame = 0; Chris@0: } Chris@0: } Chris@0: Chris@0: done: Chris@0: if (mem) Chris@0: free(mem); Chris@0: Chris@0: return frame; Chris@0: } Chris@0: Chris@0: static Chris@0: id3_length_t render_data(id3_byte_t **ptr, Chris@0: union id3_field *fields, unsigned int length) Chris@0: { Chris@0: id3_length_t size = 0; Chris@0: enum id3_field_textencoding encoding; Chris@0: unsigned int i; Chris@0: Chris@0: encoding = ID3_FIELD_TEXTENCODING_ISO_8859_1; Chris@0: Chris@0: for (i = 0; i < length; ++i) Chris@0: size += id3_field_render(&fields[i], ptr, &encoding, i < length - 1); Chris@0: Chris@0: return size; Chris@0: } Chris@0: Chris@0: /* Chris@0: * NAME: frame->render() Chris@0: * DESCRIPTION: render a single, complete frame Chris@0: */ Chris@0: id3_length_t id3_frame_render(struct id3_frame const *frame, Chris@0: id3_byte_t **ptr, int options) Chris@0: { Chris@0: id3_length_t size = 0, decoded_length, datalen; Chris@0: id3_byte_t *size_ptr = 0, *flags_ptr = 0, *data = 0; Chris@0: int flags; Chris@0: Chris@0: assert(frame); Chris@0: Chris@0: if ((frame->flags & ID3_FRAME_FLAG_TAGALTERPRESERVATION) || Chris@0: ((options & ID3_TAG_OPTION_FILEALTERED) && Chris@0: (frame->flags & ID3_FRAME_FLAG_FILEALTERPRESERVATION))) Chris@0: return 0; Chris@0: Chris@0: /* a frame must be at least 1 byte big, excluding the header */ Chris@0: Chris@0: decoded_length = render_data(0, frame->fields, frame->nfields); Chris@0: if (decoded_length == 0 && frame->encoded == 0) Chris@0: return 0; Chris@0: Chris@0: /* header */ Chris@0: Chris@0: size += id3_render_immediate(ptr, frame->id, 4); Chris@0: Chris@0: if (ptr) Chris@0: size_ptr = *ptr; Chris@0: Chris@0: size += id3_render_syncsafe(ptr, 0, 4); Chris@0: Chris@0: if (ptr) Chris@0: flags_ptr = *ptr; Chris@0: Chris@0: flags = frame->flags; Chris@0: Chris@0: size += id3_render_int(ptr, flags, 2); Chris@0: Chris@0: if (flags & (ID3_FRAME_FLAG_FORMATFLAGS & ~ID3_FRAME_FLAG_KNOWNFLAGS)) { Chris@0: size += id3_render_binary(ptr, frame->encoded, frame->encoded_length); Chris@0: if (size_ptr) Chris@0: id3_render_syncsafe(&size_ptr, size - 10, 4); Chris@0: Chris@0: return size; Chris@0: } Chris@0: Chris@0: flags &= ID3_FRAME_FLAG_KNOWNFLAGS; Chris@0: Chris@0: flags &= ~ID3_FRAME_FLAG_UNSYNCHRONISATION; Chris@0: if (options & ID3_TAG_OPTION_UNSYNCHRONISATION) Chris@0: flags |= ID3_FRAME_FLAG_UNSYNCHRONISATION; Chris@0: Chris@0: if (!(flags & ID3_FRAME_FLAG_ENCRYPTION)) { Chris@0: flags &= ~ID3_FRAME_FLAG_COMPRESSION; Chris@0: if (options & ID3_TAG_OPTION_COMPRESSION) Chris@0: flags |= ID3_FRAME_FLAG_COMPRESSION | ID3_FRAME_FLAG_DATALENGTHINDICATOR; Chris@0: } Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_GROUPINGIDENTITY) Chris@0: size += id3_render_int(ptr, frame->group_id, 1); Chris@0: if (flags & ID3_FRAME_FLAG_ENCRYPTION) Chris@0: size += id3_render_int(ptr, frame->encryption_method, 1); Chris@0: if (flags & ID3_FRAME_FLAG_DATALENGTHINDICATOR) { Chris@0: if (flags & ID3_FRAME_FLAG_ENCRYPTION) Chris@0: decoded_length = frame->decoded_length; Chris@0: size += id3_render_syncsafe(ptr, decoded_length, 4); Chris@0: } Chris@0: Chris@0: if (ptr) Chris@0: data = *ptr; Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_ENCRYPTION) Chris@0: datalen = id3_render_binary(ptr, frame->encoded, frame->encoded_length); Chris@0: else { Chris@0: if (ptr == 0) Chris@0: datalen = decoded_length; Chris@0: else { Chris@0: datalen = render_data(ptr, frame->fields, frame->nfields); Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_COMPRESSION) { Chris@0: id3_byte_t *comp; Chris@0: id3_length_t complen; Chris@0: Chris@0: comp = id3_util_compress(data, datalen, &complen); Chris@0: if (comp == 0) Chris@0: flags &= ~ID3_FRAME_FLAG_COMPRESSION; Chris@0: else { Chris@0: *ptr = data; Chris@0: datalen = id3_render_binary(ptr, comp, complen); Chris@0: Chris@0: free(comp); Chris@0: } Chris@0: } Chris@0: } Chris@0: } Chris@0: Chris@0: /* unsynchronisation */ Chris@0: Chris@0: if (flags & ID3_FRAME_FLAG_UNSYNCHRONISATION) { Chris@0: if (data == 0) Chris@0: datalen *= 2; Chris@0: else { Chris@0: id3_length_t newlen; Chris@0: Chris@0: newlen = id3_util_unsynchronise(data, datalen); Chris@0: if (newlen == datalen) Chris@0: flags &= ~ID3_FRAME_FLAG_UNSYNCHRONISATION; Chris@0: else { Chris@0: *ptr += newlen - datalen; Chris@0: datalen = newlen; Chris@0: } Chris@0: } Chris@0: } Chris@0: Chris@0: size += datalen; Chris@0: Chris@0: /* patch size and flags */ Chris@0: Chris@0: if (size_ptr) Chris@0: id3_render_syncsafe(&size_ptr, size - 10, 4); Chris@0: if (flags_ptr) Chris@0: id3_render_int(&flags_ptr, flags, 2); Chris@0: Chris@0: return size; Chris@0: }