mirror of
https://github.com/reactos/reactos.git
synced 2024-08-23 11:52:51 +00:00
1179 lines
39 KiB
C
1179 lines
39 KiB
C
/*
|
|
id3: ID3v2.3 and ID3v2.4 parsing (a relevant subset)
|
|
|
|
copyright 2006-2013 by the mpg123 project - free software under the terms of the LGPL 2.1
|
|
see COPYING and AUTHORS files in distribution or http://mpg123.org
|
|
initially written by Thomas Orgis
|
|
*/
|
|
|
|
#include "mpg123lib_intern.h"
|
|
#include "id3.h"
|
|
#include "debug.h"
|
|
|
|
#ifndef NO_ID3V2 /* Only the main parsing routine will always be there. */
|
|
|
|
/* We know the usual text frames plus some specifics. */
|
|
#define KNOWN_FRAMES 5
|
|
static const char frame_type[KNOWN_FRAMES][5] = { "COMM", "TXXX", "RVA2", "USLT", "APIC" };
|
|
enum frame_types { unknown = -2, text = -1, comment, extra, rva2, uslt, picture };
|
|
|
|
/* UTF support definitions */
|
|
|
|
typedef void (*text_converter)(mpg123_string *sb, const unsigned char* source, size_t len, const int noquiet);
|
|
|
|
static void convert_latin1 (mpg123_string *sb, const unsigned char* source, size_t len, const int noquiet);
|
|
static void convert_utf16bom(mpg123_string *sb, const unsigned char* source, size_t len, const int noquiet);
|
|
static void convert_utf8 (mpg123_string *sb, const unsigned char* source, size_t len, const int noquiet);
|
|
|
|
static const text_converter text_converters[4] =
|
|
{
|
|
convert_latin1,
|
|
/* We always check for (multiple) BOM in 16bit unicode. Without BOM, UTF16 BE is the default.
|
|
Errors in encoding are detected anyway. */
|
|
convert_utf16bom,
|
|
convert_utf16bom,
|
|
convert_utf8
|
|
};
|
|
|
|
static const unsigned int encoding_widths[4] = { 1, 2, 2, 1 };
|
|
|
|
/* the code starts here... */
|
|
|
|
static void null_id3_links(mpg123_handle *fr)
|
|
{
|
|
fr->id3v2.title = NULL;
|
|
fr->id3v2.artist = NULL;
|
|
fr->id3v2.album = NULL;
|
|
fr->id3v2.year = NULL;
|
|
fr->id3v2.genre = NULL;
|
|
fr->id3v2.comment = NULL;
|
|
}
|
|
|
|
void init_id3(mpg123_handle *fr)
|
|
{
|
|
fr->id3v2.version = 0; /* nothing there */
|
|
null_id3_links(fr);
|
|
fr->id3v2.comments = 0;
|
|
fr->id3v2.comment_list = NULL;
|
|
fr->id3v2.texts = 0;
|
|
fr->id3v2.text = NULL;
|
|
fr->id3v2.extras = 0;
|
|
fr->id3v2.extra = NULL;
|
|
fr->id3v2.pictures = 0;
|
|
fr->id3v2.picture = NULL;
|
|
}
|
|
|
|
/* Managing of the text, comment and extra lists. */
|
|
|
|
/* Initialize one element. */
|
|
static void init_mpg123_text(mpg123_text *txt)
|
|
{
|
|
mpg123_init_string(&txt->text);
|
|
mpg123_init_string(&txt->description);
|
|
txt->id[0] = 0;
|
|
txt->id[1] = 0;
|
|
txt->id[2] = 0;
|
|
txt->id[3] = 0;
|
|
txt->lang[0] = 0;
|
|
txt->lang[1] = 0;
|
|
txt->lang[2] = 0;
|
|
}
|
|
|
|
static void init_mpg123_picture(mpg123_picture *pic)
|
|
{
|
|
mpg123_init_string(&pic->mime_type);
|
|
mpg123_init_string(&pic->description);
|
|
pic->type = 0;
|
|
pic->size = 0;
|
|
pic->data = NULL;
|
|
}
|
|
|
|
/* Free memory of one element. */
|
|
static void free_mpg123_text(mpg123_text *txt)
|
|
{
|
|
mpg123_free_string(&txt->text);
|
|
mpg123_free_string(&txt->description);
|
|
}
|
|
|
|
static void free_mpg123_picture(mpg123_picture * pic)
|
|
{
|
|
mpg123_free_string(&pic->mime_type);
|
|
mpg123_free_string(&pic->description);
|
|
if (pic->data != NULL)
|
|
free(pic->data);
|
|
}
|
|
|
|
/* Free memory of whole list. */
|
|
#define free_comment(mh) free_id3_text(&((mh)->id3v2.comment_list), &((mh)->id3v2.comments))
|
|
#define free_text(mh) free_id3_text(&((mh)->id3v2.text), &((mh)->id3v2.texts))
|
|
#define free_extra(mh) free_id3_text(&((mh)->id3v2.extra), &((mh)->id3v2.extras))
|
|
#define free_picture(mh) free_id3_picture(&((mh)->id3v2.picture), &((mh)->id3v2.pictures))
|
|
static void free_id3_text(mpg123_text **list, size_t *size)
|
|
{
|
|
size_t i;
|
|
for(i=0; i<*size; ++i) free_mpg123_text(&((*list)[i]));
|
|
|
|
free(*list);
|
|
*list = NULL;
|
|
*size = 0;
|
|
}
|
|
static void free_id3_picture(mpg123_picture **list, size_t *size)
|
|
{
|
|
size_t i;
|
|
for(i=0; i<*size; ++i) free_mpg123_picture(&((*list)[i]));
|
|
|
|
free(*list);
|
|
*list = NULL;
|
|
*size = 0;
|
|
}
|
|
|
|
/* Add items to the list. */
|
|
#define add_comment(mh) add_id3_text(&((mh)->id3v2.comment_list), &((mh)->id3v2.comments))
|
|
#define add_text(mh) add_id3_text(&((mh)->id3v2.text), &((mh)->id3v2.texts))
|
|
#define add_extra(mh) add_id3_text(&((mh)->id3v2.extra), &((mh)->id3v2.extras))
|
|
#define add_picture(mh) add_id3_picture(&((mh)->id3v2.picture), &((mh)->id3v2.pictures))
|
|
static mpg123_text *add_id3_text(mpg123_text **list, size_t *size)
|
|
{
|
|
mpg123_text *x = safe_realloc(*list, sizeof(mpg123_text)*(*size+1));
|
|
if(x == NULL) return NULL; /* bad */
|
|
|
|
*list = x;
|
|
*size += 1;
|
|
init_mpg123_text(&((*list)[*size-1]));
|
|
|
|
return &((*list)[*size-1]); /* Return pointer to the added text. */
|
|
}
|
|
static mpg123_picture *add_id3_picture(mpg123_picture **list, size_t *size)
|
|
{
|
|
mpg123_picture *x = safe_realloc(*list, sizeof(mpg123_picture)*(*size+1));
|
|
if(x == NULL) return NULL; /* bad */
|
|
|
|
*list = x;
|
|
*size += 1;
|
|
init_mpg123_picture(&((*list)[*size-1]));
|
|
|
|
return &((*list)[*size-1]); /* Return pointer to the added picture. */
|
|
}
|
|
|
|
|
|
/* Remove the last item. */
|
|
#define pop_comment(mh) pop_id3_text(&((mh)->id3v2.comment_list), &((mh)->id3v2.comments))
|
|
#define pop_text(mh) pop_id3_text(&((mh)->id3v2.text), &((mh)->id3v2.texts))
|
|
#define pop_extra(mh) pop_id3_text(&((mh)->id3v2.extra), &((mh)->id3v2.extras))
|
|
#define pop_picture(mh) pop_id3_picture(&((mh)->id3v2.picture), &((mh)->id3v2.pictures))
|
|
static void pop_id3_text(mpg123_text **list, size_t *size)
|
|
{
|
|
mpg123_text *x;
|
|
if(*size < 1) return;
|
|
|
|
free_mpg123_text(&((*list)[*size-1]));
|
|
if(*size > 1)
|
|
{
|
|
x = safe_realloc(*list, sizeof(mpg123_text)*(*size-1));
|
|
if(x != NULL){ *list = x; *size -= 1; }
|
|
}
|
|
else
|
|
{
|
|
free(*list);
|
|
*list = NULL;
|
|
*size = 0;
|
|
}
|
|
}
|
|
static void pop_id3_picture(mpg123_picture **list, size_t *size)
|
|
{
|
|
mpg123_picture *x;
|
|
if(*size < 1) return;
|
|
|
|
free_mpg123_picture(&((*list)[*size-1]));
|
|
if(*size > 1)
|
|
{
|
|
x = safe_realloc(*list, sizeof(mpg123_picture)*(*size-1));
|
|
if(x != NULL){ *list = x; *size -= 1; }
|
|
}
|
|
else
|
|
{
|
|
free(*list);
|
|
*list = NULL;
|
|
*size = 0;
|
|
}
|
|
}
|
|
|
|
/* OK, back to the higher level functions. */
|
|
|
|
void exit_id3(mpg123_handle *fr)
|
|
{
|
|
free_picture(fr);
|
|
free_comment(fr);
|
|
free_extra(fr);
|
|
free_text(fr);
|
|
}
|
|
|
|
void reset_id3(mpg123_handle *fr)
|
|
{
|
|
exit_id3(fr);
|
|
init_id3(fr);
|
|
}
|
|
|
|
/* Set the id3v2.artist id3v2.title ... links to elements of the array. */
|
|
void id3_link(mpg123_handle *fr)
|
|
{
|
|
size_t i;
|
|
mpg123_id3v2 *v2 = &fr->id3v2;
|
|
debug("linking ID3v2");
|
|
null_id3_links(fr);
|
|
for(i=0; i<v2->texts; ++i)
|
|
{
|
|
mpg123_text *entry = &v2->text[i];
|
|
if (!strncmp("TIT2", entry->id, 4)) v2->title = &entry->text;
|
|
else if(!strncmp("TALB", entry->id, 4)) v2->album = &entry->text;
|
|
else if(!strncmp("TPE1", entry->id, 4)) v2->artist = &entry->text;
|
|
else if(!strncmp("TYER", entry->id, 4)) v2->year = &entry->text;
|
|
else if(!strncmp("TCON", entry->id, 4)) v2->genre = &entry->text;
|
|
}
|
|
for(i=0; i<v2->comments; ++i)
|
|
{
|
|
mpg123_text *entry = &v2->comment_list[i];
|
|
if(entry->description.fill == 0 || entry->description.p[0] == 0)
|
|
v2->comment = &entry->text;
|
|
}
|
|
/* When no generic comment found, use the last non-generic one. */
|
|
if(v2->comment == NULL && v2->comments > 0)
|
|
v2->comment = &v2->comment_list[v2->comments-1].text;
|
|
}
|
|
|
|
/*
|
|
Store ID3 text data in an mpg123_string; either verbatim copy or everything translated to UTF-8 encoding.
|
|
Preserve the zero string separator (I don't need strlen for the total size).
|
|
|
|
ID3v2 standard says that there should be one text frame of specific type per tag, and subsequent tags overwrite old values.
|
|
So, I always replace the text that may be stored already (perhaps with a list of zero-separated strings, though).
|
|
*/
|
|
static void store_id3_text(mpg123_string *sb, unsigned char *source, size_t source_size, const int noquiet, const int notranslate)
|
|
{
|
|
unsigned char encoding;
|
|
if(!source_size)
|
|
{
|
|
debug("Empty id3 data!");
|
|
return;
|
|
}
|
|
|
|
/* We shall just copy the data. Client wants to decode itself. */
|
|
if(notranslate)
|
|
{
|
|
/* Future: Add a path for ID3 errors. */
|
|
if(!mpg123_resize_string(sb, source_size))
|
|
{
|
|
if(noquiet) error("Cannot resize target string, out of memory?");
|
|
return;
|
|
}
|
|
memcpy(sb->p, source, source_size);
|
|
sb->fill = source_size;
|
|
debug1("stored undecoded ID3 text of size %"SIZE_P, (size_p)source_size);
|
|
return;
|
|
}
|
|
|
|
encoding = source[0];
|
|
if(encoding > mpg123_id3_enc_max)
|
|
{
|
|
if(noquiet)
|
|
error1("Unknown text encoding %u, I take no chances, sorry!", encoding);
|
|
|
|
mpg123_free_string(sb);
|
|
return;
|
|
}
|
|
id3_to_utf8(sb, encoding, source+1, source_size-1, noquiet);
|
|
|
|
if(sb->fill) debug1("UTF-8 string (the first one): %s", sb->p);
|
|
else if(noquiet) error("unable to convert string to UTF-8 (out of memory, junk input?)!");
|
|
}
|
|
|
|
/* On error, sb->size is 0. */
|
|
/* Also, encoding has been checked already! */
|
|
void id3_to_utf8(mpg123_string *sb, unsigned char encoding, const unsigned char *source, size_t source_size, int noquiet)
|
|
{
|
|
unsigned int bwidth;
|
|
debug1("encoding: %u", encoding);
|
|
/* A note: ID3v2.3 uses UCS-2 non-variable 16bit encoding, v2.4 uses UTF16.
|
|
UTF-16 uses a reserved/private range in UCS-2 to add the magic, so we just always treat it as UTF. */
|
|
bwidth = encoding_widths[encoding];
|
|
/* Hack! I've seen a stray zero byte before BOM. Is that supposed to happen? */
|
|
if(encoding != mpg123_id3_utf16be) /* UTF16be _can_ beging with a null byte! */
|
|
while(source_size > bwidth && source[0] == 0)
|
|
{
|
|
--source_size;
|
|
++source;
|
|
debug("skipped leading zero");
|
|
}
|
|
if(source_size % bwidth)
|
|
{
|
|
/* When we need two bytes for a character, it's strange to have an uneven bytestream length. */
|
|
if(noquiet) warning2("Weird tag size %d for encoding %u - I will probably trim too early or something but I think the MP3 is broken.", (int)source_size, encoding);
|
|
source_size -= source_size % bwidth;
|
|
}
|
|
text_converters[encoding](sb, source, source_size, noquiet);
|
|
}
|
|
|
|
/* You have checked encoding to be in the range already. */
|
|
static unsigned char *next_text(unsigned char* prev, unsigned char encoding, size_t limit)
|
|
{
|
|
unsigned char *text = prev;
|
|
size_t width = encoding_widths[encoding];
|
|
|
|
/* So I go lengths to find zero or double zero...
|
|
Remember bug 2834636: Only check for aligned NULLs! */
|
|
while(text-prev < (ssize_t)limit)
|
|
{
|
|
if(text[0] == 0)
|
|
{
|
|
if(width <= limit-(text-prev))
|
|
{
|
|
size_t i = 1;
|
|
for(; i<width; ++i) if(text[i] != 0) break;
|
|
|
|
if(i == width) /* found a null wide enough! */
|
|
{
|
|
text += width;
|
|
break;
|
|
}
|
|
}
|
|
else return NULL; /* No full character left? This text is broken */
|
|
}
|
|
|
|
text += width;
|
|
}
|
|
if((size_t)(text-prev) >= limit) text = NULL;
|
|
|
|
return text;
|
|
}
|
|
|
|
static const char *enc_name(unsigned char enc)
|
|
{
|
|
switch(enc)
|
|
{
|
|
case 0: return "Latin 1";
|
|
case 1: return "UTF-16 BOM";
|
|
case 2: return "UTF-16 BE";
|
|
case 3: return "UTF-8";
|
|
default: return "unknown!";
|
|
}
|
|
}
|
|
|
|
static void process_text(mpg123_handle *fr, unsigned char *realdata, size_t realsize, char *id)
|
|
{
|
|
/* Text encoding $xx */
|
|
/* The text (encoded) ... */
|
|
mpg123_text *t = add_text(fr);
|
|
if(VERBOSE4) fprintf(stderr, "Note: Storing text from %s encoding\n", enc_name(realdata[0]));
|
|
if(t == NULL)
|
|
{
|
|
if(NOQUIET) error("Unable to attach new text!");
|
|
return;
|
|
}
|
|
memcpy(t->id, id, 4);
|
|
store_id3_text(&t->text, realdata, realsize, NOQUIET, fr->p.flags & MPG123_PLAIN_ID3TEXT);
|
|
if(VERBOSE4) fprintf(stderr, "Note: ID3v2 %c%c%c%c text frame: %s\n", id[0], id[1], id[2], id[3], t->text.p);
|
|
}
|
|
|
|
static void process_picture(mpg123_handle *fr, unsigned char *realdata, size_t realsize)
|
|
{
|
|
unsigned char encoding = realdata[0];
|
|
mpg123_picture *i = NULL;
|
|
unsigned char* workpoint;
|
|
if(realsize == 0)
|
|
{
|
|
debug("Empty id3 data!");
|
|
return;
|
|
}
|
|
if(encoding > mpg123_id3_enc_max)
|
|
{
|
|
if(NOQUIET)
|
|
error1("Unknown text encoding %u, I take no chances, sorry!", encoding);
|
|
return;
|
|
}
|
|
if(VERBOSE4) fprintf(stderr, "Note: Storing picture from APIC frame.\n");
|
|
/* decompose realdata accordingly */
|
|
i = add_picture(fr);
|
|
if(i == NULL)
|
|
{
|
|
if(NOQUIET) error("Unable to attach new picture!");
|
|
return;
|
|
}
|
|
realdata++; realsize--;
|
|
/* get mime type (encoding is always latin-1) */
|
|
workpoint = next_text(realdata, 0, realsize);
|
|
if (workpoint == NULL) {
|
|
pop_picture(fr);
|
|
if (NOQUIET) error("Unable to get mime type for picture; skipping picture.");
|
|
return;
|
|
}
|
|
id3_to_utf8(&i->mime_type, 0, realdata, workpoint - realdata, NOQUIET);
|
|
realsize -= workpoint - realdata;
|
|
realdata = workpoint;
|
|
/* get picture type */
|
|
i->type = realdata[0];
|
|
realdata++; realsize--;
|
|
/* get description (encoding is encoding) */
|
|
workpoint = next_text(realdata, encoding, realsize);
|
|
if (workpoint == NULL) {
|
|
if (NOQUIET) error("Unable to get description for picture; skipping picture.");
|
|
pop_picture(fr);
|
|
return;
|
|
}
|
|
id3_to_utf8(&i->description, encoding, realdata, workpoint - realdata, NOQUIET);
|
|
realsize -= workpoint - realdata;
|
|
if (realsize == 0) {
|
|
if (NOQUIET) error("No picture data defined; skipping picture.");
|
|
pop_picture(fr);
|
|
return;
|
|
}
|
|
/* store_id3_picture(i, picture, realsize, NOQUIET)) */
|
|
i->data = (unsigned char*)malloc(realsize);
|
|
if (i->data == NULL) {
|
|
if (NOQUIET) error("Unable to allocate memory for picture; skipping picture");
|
|
pop_picture(fr);
|
|
return;
|
|
}
|
|
memcpy(i->data, workpoint, realsize);
|
|
i->size = realsize;
|
|
if(VERBOSE4) fprintf(stderr, "Note: ID3v2 APIC picture frame of type: %d\n", i->type);
|
|
}
|
|
|
|
/* Store a new comment that perhaps is a RVA / RVA_ALBUM/AUDIOPHILE / RVA_MIX/RADIO one
|
|
Special gimmik: It also stores USLT to the texts. Stucture is the same as for comments. */
|
|
static void process_comment(mpg123_handle *fr, enum frame_types tt, unsigned char *realdata, size_t realsize, int rva_level, char *id)
|
|
{
|
|
/* Text encoding $xx */
|
|
/* Language $xx xx xx */
|
|
/* Short description (encoded!) <text> $00 (00) */
|
|
/* Then the comment text (encoded) ... */
|
|
unsigned char encoding = realdata[0];
|
|
unsigned char *lang = realdata+1; /* I'll only use the 3 bytes! */
|
|
unsigned char *descr = realdata+4;
|
|
unsigned char *text = NULL;
|
|
mpg123_text *xcom = NULL;
|
|
mpg123_text localcom; /* UTF-8 variant for local processing. */
|
|
|
|
if(realsize < (size_t)(descr-realdata))
|
|
{
|
|
if(NOQUIET) error1("Invalid frame size of %"SIZE_P" (too small for anything).", (size_p)realsize);
|
|
return;
|
|
}
|
|
if(encoding > mpg123_id3_enc_max)
|
|
{
|
|
if(NOQUIET)
|
|
error1("Unknown text encoding %u, I take no chances, sorry!", encoding);
|
|
return;
|
|
}
|
|
xcom = (tt == uslt ? add_text(fr) : add_comment(fr));
|
|
if(VERBOSE4) fprintf(stderr, "Note: Storing comment from %s encoding\n", enc_name(realdata[0]));
|
|
if(xcom == NULL)
|
|
{
|
|
if(NOQUIET) error("Unable to attach new comment!");
|
|
return;
|
|
}
|
|
memcpy(xcom->lang, lang, 3);
|
|
memcpy(xcom->id, id, 4);
|
|
/* Now I can abuse a byte from lang for the encoding. */
|
|
descr[-1] = encoding;
|
|
/* Be careful with finding the end of description, I have to honor encoding here. */
|
|
text = next_text(descr, encoding, realsize-(descr-realdata));
|
|
if(text == NULL)
|
|
{
|
|
if(NOQUIET) error("No comment text / valid description?");
|
|
pop_comment(fr);
|
|
return;
|
|
}
|
|
|
|
init_mpg123_text(&localcom);
|
|
/* Store the text, without translation to UTF-8, but for comments always a local copy in UTF-8.
|
|
Reminder: No bailing out from here on without freeing the local comment data! */
|
|
store_id3_text(&xcom->description, descr-1, text-descr+1, NOQUIET, fr->p.flags & MPG123_PLAIN_ID3TEXT);
|
|
if(tt == comment)
|
|
store_id3_text(&localcom.description, descr-1, text-descr+1, NOQUIET, 0);
|
|
|
|
text[-1] = encoding; /* Byte abusal for encoding... */
|
|
store_id3_text(&xcom->text, text-1, realsize+1-(text-realdata), NOQUIET, fr->p.flags & MPG123_PLAIN_ID3TEXT);
|
|
/* Remember: I will probably decode the above (again) for rva comment checking. So no messing around, please. */
|
|
|
|
if(VERBOSE4) /* Do _not_ print the verbatim text: The encoding might be funny! */
|
|
{
|
|
fprintf(stderr, "Note: ID3 comm/uslt desc of length %"SIZE_P".\n", (size_p)xcom->description.fill);
|
|
fprintf(stderr, "Note: ID3 comm/uslt text of length %"SIZE_P".\n", (size_p)xcom->text.fill);
|
|
}
|
|
/* Look out for RVA info only when we really deal with a straight comment. */
|
|
if(tt == comment && localcom.description.fill > 0)
|
|
{
|
|
int rva_mode = -1; /* mix / album */
|
|
if( !strcasecmp(localcom.description.p, "rva")
|
|
|| !strcasecmp(localcom.description.p, "rva_mix")
|
|
|| !strcasecmp(localcom.description.p, "rva_track")
|
|
|| !strcasecmp(localcom.description.p, "rva_radio") )
|
|
rva_mode = 0;
|
|
else if( !strcasecmp(localcom.description.p, "rva_album")
|
|
|| !strcasecmp(localcom.description.p, "rva_audiophile")
|
|
|| !strcasecmp(localcom.description.p, "rva_user") )
|
|
rva_mode = 1;
|
|
if((rva_mode > -1) && (fr->rva.level[rva_mode] <= rva_level))
|
|
{
|
|
/* Only translate the contents in here where we really need them. */
|
|
store_id3_text(&localcom.text, text-1, realsize+1-(text-realdata), NOQUIET, 0);
|
|
if(localcom.text.fill > 0)
|
|
{
|
|
fr->rva.gain[rva_mode] = (float) atof(localcom.text.p);
|
|
if(VERBOSE3) fprintf(stderr, "Note: RVA value %fdB\n", fr->rva.gain[rva_mode]);
|
|
fr->rva.peak[rva_mode] = 0;
|
|
fr->rva.level[rva_mode] = rva_level;
|
|
}
|
|
}
|
|
}
|
|
/* Make sure to free the local memory... */
|
|
free_mpg123_text(&localcom);
|
|
}
|
|
|
|
static void process_extra(mpg123_handle *fr, unsigned char* realdata, size_t realsize, int rva_level, char *id)
|
|
{
|
|
/* Text encoding $xx */
|
|
/* Description ... $00 (00) */
|
|
/* Text ... */
|
|
unsigned char encoding = realdata[0];
|
|
unsigned char *descr = realdata+1; /* remember, the encoding is descr[-1] */
|
|
unsigned char *text;
|
|
mpg123_text *xex;
|
|
mpg123_text localex;
|
|
|
|
if((int)realsize < descr-realdata)
|
|
{
|
|
if(NOQUIET) error1("Invalid frame size of %lu (too small for anything).", (unsigned long)realsize);
|
|
return;
|
|
}
|
|
if(encoding > mpg123_id3_enc_max)
|
|
{
|
|
if(NOQUIET)
|
|
error1("Unknown text encoding %u, I take no chances, sorry!", encoding);
|
|
return;
|
|
}
|
|
text = next_text(descr, encoding, realsize-(descr-realdata));
|
|
if(VERBOSE4) fprintf(stderr, "Note: Storing extra from %s encoding\n", enc_name(realdata[0]));
|
|
if(text == NULL)
|
|
{
|
|
if(NOQUIET) error("No extra frame text / valid description?");
|
|
return;
|
|
}
|
|
xex = add_extra(fr);
|
|
if(xex == NULL)
|
|
{
|
|
if(NOQUIET) error("Unable to attach new extra text!");
|
|
return;
|
|
}
|
|
memcpy(xex->id, id, 4);
|
|
init_mpg123_text(&localex); /* For our local copy. */
|
|
|
|
/* The outside storage gets reencoded to UTF-8 only if not requested otherwise.
|
|
Remember that we really need the -1 here to hand in the encoding byte!*/
|
|
store_id3_text(&xex->description, descr-1, text-descr+1, NOQUIET, fr->p.flags & MPG123_PLAIN_ID3TEXT);
|
|
/* Our local copy is always stored in UTF-8! */
|
|
store_id3_text(&localex.description, descr-1, text-descr+1, NOQUIET, 0);
|
|
/* At first, only store the outside copy of the payload. We may not need the local copy. */
|
|
text[-1] = encoding;
|
|
store_id3_text(&xex->text, text-1, realsize-(text-realdata)+1, NOQUIET, fr->p.flags & MPG123_PLAIN_ID3TEXT);
|
|
|
|
/* Now check if we would like to interpret this extra info for RVA. */
|
|
if(localex.description.fill > 0)
|
|
{
|
|
int is_peak = 0;
|
|
int rva_mode = -1; /* mix / album */
|
|
|
|
if(!strncasecmp(localex.description.p, "replaygain_track_",17))
|
|
{
|
|
if(VERBOSE3) fprintf(stderr, "Note: RVA ReplayGain track gain/peak\n");
|
|
|
|
rva_mode = 0;
|
|
if(!strcasecmp(localex.description.p, "replaygain_track_peak")) is_peak = 1;
|
|
else if(strcasecmp(localex.description.p, "replaygain_track_gain")) rva_mode = -1;
|
|
}
|
|
else
|
|
if(!strncasecmp(localex.description.p, "replaygain_album_",17))
|
|
{
|
|
if(VERBOSE3) fprintf(stderr, "Note: RVA ReplayGain album gain/peak\n");
|
|
|
|
rva_mode = 1;
|
|
if(!strcasecmp(localex.description.p, "replaygain_album_peak")) is_peak = 1;
|
|
else if(strcasecmp(localex.description.p, "replaygain_album_gain")) rva_mode = -1;
|
|
}
|
|
if((rva_mode > -1) && (fr->rva.level[rva_mode] <= rva_level))
|
|
{
|
|
/* Now we need the translated copy of the data. */
|
|
store_id3_text(&localex.text, text-1, realsize-(text-realdata)+1, NOQUIET, 0);
|
|
if(localex.text.fill > 0)
|
|
{
|
|
if(is_peak)
|
|
{
|
|
fr->rva.peak[rva_mode] = (float) atof(localex.text.p);
|
|
if(VERBOSE3) fprintf(stderr, "Note: RVA peak %f\n", fr->rva.peak[rva_mode]);
|
|
}
|
|
else
|
|
{
|
|
fr->rva.gain[rva_mode] = (float) atof(localex.text.p);
|
|
if(VERBOSE3) fprintf(stderr, "Note: RVA gain %fdB\n", fr->rva.gain[rva_mode]);
|
|
}
|
|
fr->rva.level[rva_mode] = rva_level;
|
|
}
|
|
}
|
|
}
|
|
|
|
free_mpg123_text(&localex);
|
|
}
|
|
|
|
/* Make a ID3v2.3+ 4-byte ID from a ID3v2.2 3-byte ID
|
|
Note that not all frames survived to 2.4; the mapping goes to 2.3 .
|
|
A notable miss is the old RVA frame, which is very unspecific anyway.
|
|
This function returns -1 when a not known 3 char ID was encountered, 0 otherwise. */
|
|
static int promote_framename(mpg123_handle *fr, char *id) /* fr because of VERBOSE macros */
|
|
{
|
|
size_t i;
|
|
char *old[] =
|
|
{
|
|
"COM", "TAL", "TBP", "TCM", "TCO", "TCR", "TDA", "TDY", "TEN", "TFT",
|
|
"TIM", "TKE", "TLA", "TLE", "TMT", "TOA", "TOF", "TOL", "TOR", "TOT",
|
|
"TP1", "TP2", "TP3", "TP4", "TPA", "TPB", "TRC", "TDA", "TRK", "TSI",
|
|
"TSS", "TT1", "TT2", "TT3", "TXT", "TXX", "TYE"
|
|
};
|
|
char *new[] =
|
|
{
|
|
"COMM", "TALB", "TBPM", "TCOM", "TCON", "TCOP", "TDAT", "TDLY", "TENC", "TFLT",
|
|
"TIME", "TKEY", "TLAN", "TLEN", "TMED", "TOPE", "TOFN", "TOLY", "TORY", "TOAL",
|
|
"TPE1", "TPE2", "TPE3", "TPE4", "TPOS", "TPUB", "TSRC", "TRDA", "TRCK", "TSIZ",
|
|
"TSSE", "TIT1", "TIT2", "TIT3", "TEXT", "TXXX", "TYER"
|
|
};
|
|
for(i=0; i<sizeof(old)/sizeof(char*); ++i)
|
|
{
|
|
if(!strncmp(id, old[i], 3))
|
|
{
|
|
memcpy(id, new[i], 4);
|
|
if(VERBOSE3) fprintf(stderr, "Translated ID3v2.2 frame %s to %s\n", old[i], new[i]);
|
|
return 0;
|
|
}
|
|
}
|
|
if(VERBOSE3) fprintf(stderr, "Ignoring untranslated ID3v2.2 frame %c%c%c\n", id[0], id[1], id[2]);
|
|
return -1;
|
|
}
|
|
|
|
#endif /* NO_ID3V2 */
|
|
|
|
/*
|
|
trying to parse ID3v2.3 and ID3v2.4 tags...
|
|
|
|
returns: 0: bad or just unparseable tag
|
|
1: good, (possibly) new tag info
|
|
<0: reader error (may need more data feed, try again)
|
|
*/
|
|
int parse_new_id3(mpg123_handle *fr, unsigned long first4bytes)
|
|
{
|
|
#define UNSYNC_FLAG 128
|
|
#define EXTHEAD_FLAG 64
|
|
#define EXP_FLAG 32
|
|
#define FOOTER_FLAG 16
|
|
#define UNKNOWN_FLAGS 15 /* 00001111*/
|
|
unsigned char buf[6];
|
|
unsigned long length=0;
|
|
unsigned char flags = 0;
|
|
int ret = 1;
|
|
int ret2;
|
|
#ifndef NO_ID3V2
|
|
int skiptag = 0;
|
|
#endif
|
|
unsigned char major = first4bytes & 0xff;
|
|
debug1("ID3v2: major tag version: %i", major);
|
|
if(major == 0xff) return 0; /* Invalid... */
|
|
if((ret2 = fr->rd->read_frame_body(fr, buf, 6)) < 0) /* read more header information */
|
|
return ret2;
|
|
|
|
if(buf[0] == 0xff) return 0; /* Revision, will never be 0xff. */
|
|
|
|
/* second new byte are some nice flags, if these are invalid skip the whole thing */
|
|
flags = buf[1];
|
|
debug1("ID3v2: flags 0x%08x", flags);
|
|
/* use 4 bytes from buf to construct 28bit uint value and return 1; return 0 if bytes are not synchsafe */
|
|
#define synchsafe_to_long(buf,res) \
|
|
( \
|
|
(((buf)[0]|(buf)[1]|(buf)[2]|(buf)[3]) & 0x80) ? 0 : \
|
|
(res = (((unsigned long) (buf)[0]) << 21) \
|
|
| (((unsigned long) (buf)[1]) << 14) \
|
|
| (((unsigned long) (buf)[2]) << 7) \
|
|
| ((unsigned long) (buf)[3]) \
|
|
,1) \
|
|
)
|
|
/* id3v2.3 does not store synchsafe frame sizes, but synchsafe tag size - doh! */
|
|
/* Remember: bytes_to_long() can yield ULONG_MAX on 32 bit platforms! */
|
|
#define bytes_to_long(buf,res) \
|
|
( \
|
|
major == 3 ? \
|
|
(res = (((unsigned long) (buf)[0]) << 24) \
|
|
| (((unsigned long) (buf)[1]) << 16) \
|
|
| (((unsigned long) (buf)[2]) << 8) \
|
|
| ((unsigned long) (buf)[3]) \
|
|
,1) : synchsafe_to_long(buf,res) \
|
|
)
|
|
/* for id3v2.2 only */
|
|
#define threebytes_to_long(buf,res) \
|
|
( \
|
|
res = (((unsigned long) (buf)[0]) << 16) \
|
|
| (((unsigned long) (buf)[1]) << 8) \
|
|
| ((unsigned long) (buf)[2]) \
|
|
)
|
|
|
|
/* length-10 or length-20 (footer present); 4 synchsafe integers == 28 bit number */
|
|
/* we have already read 10 bytes, so left are length or length+10 bytes belonging to tag */
|
|
/* Note: This is an 28 bit value in 32 bit storage, plenty of space for */
|
|
/* length+x for reasonable x. */
|
|
if(!synchsafe_to_long(buf+2,length))
|
|
{
|
|
if(NOQUIET) error4("Bad tag length (not synchsafe): 0x%02x%02x%02x%02x; You got a bad ID3 tag here.", buf[2],buf[3],buf[4],buf[5]);
|
|
return 0;
|
|
}
|
|
debug1("ID3v2: tag data length %lu", length);
|
|
#ifndef NO_ID3V2
|
|
if(VERBOSE2) fprintf(stderr,"Note: ID3v2.%i rev %i tag of %lu bytes\n", major, buf[0], length);
|
|
/* skip if unknown version/scary flags, parse otherwise */
|
|
if(fr->p.flags & MPG123_SKIP_ID3V2)
|
|
{
|
|
if(VERBOSE3)
|
|
fprintf(stderr, "Note: Skipping ID3v2 tag per user request.\n");
|
|
skiptag = 1;
|
|
}
|
|
if((flags & UNKNOWN_FLAGS) || (major > 4) || (major < 2))
|
|
{
|
|
if(NOQUIET)
|
|
warning2( "ID3v2: Won't parse the ID3v2 tag with major version"
|
|
" %u and flags 0x%xu - some extra code may be needed"
|
|
, major, flags );
|
|
skiptag = 1;
|
|
}
|
|
if(length < 10)
|
|
{
|
|
if(NOQUIET)
|
|
warning1("ID3v2: unrealistic small tag lengh %lu, skipping", length);
|
|
skiptag = 1;
|
|
}
|
|
if(skiptag)
|
|
{
|
|
#endif
|
|
if((ret2 = fr->rd->skip_bytes(fr,length)) < 0) /* will not store data in backbuff! */
|
|
ret = ret2;
|
|
#ifndef NO_ID3V2
|
|
}
|
|
else
|
|
{
|
|
unsigned char* tagdata = NULL;
|
|
fr->id3v2.version = major;
|
|
/* try to interpret that beast */
|
|
if((tagdata = (unsigned char*) malloc(length+1)) != NULL)
|
|
{
|
|
debug("ID3v2: analysing frames...");
|
|
if((ret2 = fr->rd->read_frame_body(fr,tagdata,length)) > 0)
|
|
{
|
|
unsigned long tagpos = 0;
|
|
/* bytes of frame title and of framesize value */
|
|
unsigned int head_part = fr->id3v2.version > 2 ? 4 : 3;
|
|
unsigned int flag_part = fr->id3v2.version > 2 ? 2 : 0;
|
|
/* The amount of bytes that are unconditionally read for each frame: */
|
|
/* ID, size, flags. */
|
|
unsigned int framebegin = head_part+head_part+flag_part;
|
|
debug1("ID3v2: have read at all %lu bytes for the tag now", (unsigned long)length+6);
|
|
/* going to apply strlen for strings inside frames, make sure that it doesn't overflow! */
|
|
tagdata[length] = 0;
|
|
if(flags & EXTHEAD_FLAG)
|
|
{
|
|
debug("ID3v2: skipping extended header");
|
|
if(!bytes_to_long(tagdata, tagpos) || tagpos >= length)
|
|
{
|
|
ret = 0;
|
|
if(NOQUIET)
|
|
error4( "Bad (non-synchsafe/too large) tag offset:"
|
|
"0x%02x%02x%02x%02x"
|
|
, tagdata[0], tagdata[1], tagdata[2], tagdata[3] );
|
|
}
|
|
}
|
|
if(ret > 0)
|
|
{
|
|
char id[5];
|
|
unsigned long framesize;
|
|
unsigned long fflags; /* need 16 bits, actually */
|
|
id[4] = 0;
|
|
/* Pos now advanced after ext head, now a frame has to follow. */
|
|
/* Note: tagpos <= length, which is 28 bit integer, so both */
|
|
/* far away from overflow for adding known small values. */
|
|
/* I want to read at least one full header now. */
|
|
while(length >= tagpos+framebegin)
|
|
{
|
|
int i = 0;
|
|
unsigned long pos = tagpos;
|
|
/* level 1,2,3 - 0 is info from lame/info tag! */
|
|
/* rva tags with ascending significance, then general frames */
|
|
enum frame_types tt = unknown;
|
|
/* we may have entered the padding zone or any other strangeness: check if we have valid frame id characters */
|
|
for(i=0; i< head_part; ++i)
|
|
if( !( ((tagdata[tagpos+i] > 47) && (tagdata[tagpos+i] < 58))
|
|
|| ((tagdata[tagpos+i] > 64) && (tagdata[tagpos+i] < 91)) ) )
|
|
{
|
|
debug5("ID3v2: real tag data apparently ended after %lu bytes with 0x%02x%02x%02x%02x", tagpos, tagdata[tagpos], tagdata[tagpos+1], tagdata[tagpos+2], tagdata[tagpos+3]);
|
|
/* This is no hard error... let's just hope that we got something meaningful already (ret==1 in that case). */
|
|
goto tagparse_cleanup; /* Need to escape two loops here. */
|
|
}
|
|
if(ret > 0)
|
|
{
|
|
/* 4 or 3 bytes id */
|
|
strncpy(id, (char*) tagdata+pos, head_part);
|
|
id[head_part] = 0; /* terminate for 3 or 4 bytes */
|
|
pos += head_part;
|
|
tagpos += head_part;
|
|
/* size as 32 bits or 28 bits */
|
|
if(fr->id3v2.version == 2) threebytes_to_long(tagdata+pos, framesize);
|
|
else
|
|
if(!bytes_to_long(tagdata+pos, framesize))
|
|
{
|
|
/* Just assume that up to now there was some good data. */
|
|
if(NOQUIET) error1("ID3v2: non-syncsafe size of %s frame, skipping the remainder of tag", id);
|
|
break;
|
|
}
|
|
if(VERBOSE3) fprintf(stderr, "Note: ID3v2 %s frame of size %lu\n", id, framesize);
|
|
tagpos += head_part;
|
|
pos += head_part;
|
|
if(fr->id3v2.version > 2)
|
|
{
|
|
fflags = (((unsigned long) tagdata[pos]) << 8) | ((unsigned long) tagdata[pos+1]);
|
|
pos += 2;
|
|
tagpos += 2;
|
|
}
|
|
else fflags = 0;
|
|
|
|
if(length - tagpos < framesize)
|
|
{
|
|
if(NOQUIET) error("Whoa! ID3v2 frame claims to be larger than the whole rest of the tag.");
|
|
break;
|
|
}
|
|
tagpos += framesize; /* the important advancement in whole tag */
|
|
/* for sanity, after full parsing tagpos should be == pos */
|
|
/* debug4("ID3v2: found %s frame, size %lu (as bytes: 0x%08lx), flags 0x%016lx", id, framesize, framesize, fflags); */
|
|
/* %0abc0000 %0h00kmnp */
|
|
#define BAD_FFLAGS (unsigned long) 36784
|
|
#define PRES_TAG_FFLAG 16384
|
|
#define PRES_FILE_FFLAG 8192
|
|
#define READ_ONLY_FFLAG 4096
|
|
#define GROUP_FFLAG 64
|
|
#define COMPR_FFLAG 8
|
|
#define ENCR_FFLAG 4
|
|
#define UNSYNC_FFLAG 2
|
|
#define DATLEN_FFLAG 1
|
|
if(head_part < 4 && promote_framename(fr, id) != 0) continue;
|
|
|
|
/* shall not or want not handle these */
|
|
if(fflags & (BAD_FFLAGS | COMPR_FFLAG | ENCR_FFLAG))
|
|
{
|
|
if(NOQUIET) warning("ID3v2: skipping invalid/unsupported frame");
|
|
continue;
|
|
}
|
|
|
|
for(i = 0; i < KNOWN_FRAMES; ++i)
|
|
if(!strncmp(frame_type[i], id, 4)){ tt = i; break; }
|
|
|
|
if(id[0] == 'T' && tt != extra) tt = text;
|
|
|
|
if(tt != unknown)
|
|
{
|
|
int rva_mode = -1; /* mix / album */
|
|
unsigned long realsize = framesize;
|
|
unsigned char* realdata = tagdata+pos;
|
|
if((flags & UNSYNC_FLAG) || (fflags & UNSYNC_FFLAG))
|
|
{
|
|
unsigned long ipos = 0;
|
|
unsigned long opos = 0;
|
|
debug("Id3v2: going to de-unsync the frame data");
|
|
/* de-unsync: FF00 -> FF; real FF00 is simply represented as FF0000 ... */
|
|
/* damn, that means I have to delete bytes from withing the data block... thus need temporal storage */
|
|
/* standard mandates that de-unsync should always be safe if flag is set */
|
|
realdata = (unsigned char*) malloc(framesize); /* will need <= bytes */
|
|
if(realdata == NULL)
|
|
{
|
|
if(NOQUIET) error("ID3v2: unable to allocate working buffer for de-unsync");
|
|
continue;
|
|
}
|
|
/* now going byte per byte through the data... */
|
|
realdata[0] = tagdata[pos];
|
|
opos = 1;
|
|
for(ipos = pos+1; ipos < pos+framesize; ++ipos)
|
|
{
|
|
if(!((tagdata[ipos] == 0) && (tagdata[ipos-1] == 0xff)))
|
|
{
|
|
realdata[opos++] = tagdata[ipos];
|
|
}
|
|
}
|
|
realsize = opos;
|
|
debug2("ID3v2: de-unsync made %lu out of %lu bytes", realsize, framesize);
|
|
}
|
|
pos = 0; /* now at the beginning again... */
|
|
/* Avoid reading over boundary, even if there is a */
|
|
/* zero byte of padding for safety. */
|
|
if(realsize) switch(tt)
|
|
{
|
|
case comment:
|
|
case uslt:
|
|
process_comment(fr, tt, realdata, realsize, comment+1, id);
|
|
break;
|
|
case extra: /* perhaps foobar2000's work */
|
|
process_extra(fr, realdata, realsize, extra+1, id);
|
|
break;
|
|
case rva2: /* "the" RVA tag */
|
|
{
|
|
/* starts with null-terminated identification */
|
|
if(VERBOSE3) fprintf(stderr, "Note: RVA2 identification \"%s\"\n", realdata);
|
|
/* default: some individual value, mix mode */
|
|
rva_mode = 0;
|
|
if( !strncasecmp((char*)realdata, "album", 5)
|
|
|| !strncasecmp((char*)realdata, "audiophile", 10)
|
|
|| !strncasecmp((char*)realdata, "user", 4))
|
|
rva_mode = 1;
|
|
if(fr->rva.level[rva_mode] <= rva2+1)
|
|
{
|
|
pos += strlen((char*) realdata) + 1;
|
|
if(realdata[pos] == 1)
|
|
{
|
|
++pos;
|
|
/* only handle master channel */
|
|
debug("ID3v2: it is for the master channel");
|
|
/* two bytes adjustment, one byte for bits representing peak - n bytes, eh bits, for peak */
|
|
/* 16 bit signed integer = dB * 512 ... the double cast is needed to preserve the sign of negative values! */
|
|
fr->rva.gain[rva_mode] = (float) ( (((short)((signed char)realdata[pos])) << 8) | realdata[pos+1] ) / 512;
|
|
pos += 2;
|
|
if(VERBOSE3) fprintf(stderr, "Note: RVA value %fdB\n", fr->rva.gain[rva_mode]);
|
|
/* heh, the peak value is represented by a number of bits - but in what manner? Skipping that part */
|
|
fr->rva.peak[rva_mode] = 0;
|
|
fr->rva.level[rva_mode] = rva2+1;
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
/* non-rva metainfo, simply store... */
|
|
case text:
|
|
process_text(fr, realdata, realsize, id);
|
|
break;
|
|
case picture:
|
|
if (fr->p.flags & MPG123_PICTURE)
|
|
process_picture(fr, realdata, realsize);
|
|
|
|
break;
|
|
default: if(NOQUIET) error1("ID3v2: unknown frame type %i", tt);
|
|
}
|
|
if((flags & UNSYNC_FLAG) || (fflags & UNSYNC_FFLAG)) free(realdata);
|
|
}
|
|
#undef BAD_FFLAGS
|
|
#undef PRES_TAG_FFLAG
|
|
#undef PRES_FILE_FFLAG
|
|
#undef READ_ONLY_FFLAG
|
|
#undef GROUP_FFLAG
|
|
#undef COMPR_FFLAG
|
|
#undef ENCR_FFLAG
|
|
#undef UNSYNC_FFLAG
|
|
#undef DATLEN_FFLAG
|
|
}
|
|
else break;
|
|
#undef KNOWN_FRAMES
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* There are tags with zero length. Strictly not an error, then. */
|
|
if(length > 0 && NOQUIET && ret2 != MPG123_NEED_MORE) error("ID3v2: Duh, not able to read ID3v2 tag data.");
|
|
ret = ret2;
|
|
}
|
|
tagparse_cleanup:
|
|
free(tagdata);
|
|
}
|
|
else
|
|
{
|
|
if(NOQUIET) error1("ID3v2: Arrg! Unable to allocate %lu bytes for interpreting ID3v2 data - trying to skip instead.", length);
|
|
if((ret2 = fr->rd->skip_bytes(fr,length)) < 0) ret = ret2; /* will not store data in backbuff! */
|
|
else ret = 0;
|
|
}
|
|
}
|
|
#endif /* NO_ID3V2 */
|
|
/* skip footer if present */
|
|
if((ret > 0) && (flags & FOOTER_FLAG) && ((ret2 = fr->rd->skip_bytes(fr,length)) < 0)) ret = ret2;
|
|
|
|
return ret;
|
|
#undef UNSYNC_FLAG
|
|
#undef EXTHEAD_FLAG
|
|
#undef EXP_FLAG
|
|
#undef FOOTER_FLAG
|
|
#undef UNKOWN_FLAGS
|
|
}
|
|
|
|
#ifndef NO_ID3V2 /* Disabling all the rest... */
|
|
|
|
static void convert_latin1(mpg123_string *sb, const unsigned char* s, size_t l, const int noquiet)
|
|
{
|
|
size_t length = l;
|
|
size_t i;
|
|
unsigned char *p;
|
|
/* determine real length, a latin1 character can at most take 2 in UTF8 */
|
|
for(i=0; i<l; ++i)
|
|
if(s[i] >= 0x80) ++length;
|
|
|
|
debug1("UTF-8 length: %lu", (unsigned long)length);
|
|
/* one extra zero byte for paranoia */
|
|
if(!mpg123_resize_string(sb, length+1)){ mpg123_free_string(sb); return ; }
|
|
|
|
p = (unsigned char*) sb->p; /* Signedness doesn't matter but it shows I thought about the non-issue */
|
|
for(i=0; i<l; ++i)
|
|
if(s[i] < 0x80){ *p = s[i]; ++p; }
|
|
else /* two-byte encoding */
|
|
{
|
|
*p = 0xc0 | (s[i]>>6);
|
|
*(p+1) = 0x80 | (s[i] & 0x3f);
|
|
p+=2;
|
|
}
|
|
|
|
sb->p[length] = 0;
|
|
sb->fill = length+1;
|
|
}
|
|
|
|
/*
|
|
Check if we have a byte oder mark(s) there, return:
|
|
-1: little endian
|
|
0: no BOM
|
|
1: big endian
|
|
|
|
This modifies source and len to indicate the data _after_ the BOM(s).
|
|
Note on nasty data: The last encountered BOM determines the endianness.
|
|
I have seen data with multiple BOMS, namely from "the" id3v2 program.
|
|
Not nice, but what should I do?
|
|
*/
|
|
static int check_bom(const unsigned char** source, size_t *len)
|
|
{
|
|
int this_bom = 0;
|
|
int further_bom = 0;
|
|
|
|
if(*len < 2) return 0;
|
|
|
|
if((*source)[0] == 0xff && (*source)[1] == 0xfe)
|
|
this_bom = -1;
|
|
|
|
if((*source)[0] == 0xfe && (*source)[1] == 0xff)
|
|
this_bom = 1;
|
|
|
|
/* Skip the detected BOM. */
|
|
if(this_bom != 0)
|
|
{
|
|
*source += 2;
|
|
*len -= 2;
|
|
/* Check for following BOMs. The last one wins! */
|
|
further_bom = check_bom(source, len);
|
|
if(further_bom == 0) return this_bom; /* End of the recursion. */
|
|
else return further_bom;
|
|
}
|
|
else return 0;
|
|
}
|
|
|
|
#define FULLPOINT(f,s) ( (((f)&0x3ff)<<10) + ((s)&0x3ff) + 0x10000 )
|
|
/* Remember: There's a limit at 0x1ffff. */
|
|
#define UTF8LEN(x) ( (x)<0x80 ? 1 : ((x)<0x800 ? 2 : ((x)<0x10000 ? 3 : 4)))
|
|
static void convert_utf16bom(mpg123_string *sb, const unsigned char* s, size_t l, const int noquiet)
|
|
{
|
|
size_t i;
|
|
size_t n; /* number bytes that make up full pairs */
|
|
unsigned char *p;
|
|
size_t length = 0; /* the resulting UTF-8 length */
|
|
/* Determine real length... extreme case can be more than utf-16 length. */
|
|
size_t high = 0;
|
|
size_t low = 1;
|
|
int bom_endian;
|
|
|
|
debug1("convert_utf16 with length %lu", (unsigned long)l);
|
|
|
|
bom_endian = check_bom(&s, &l);
|
|
debug1("UTF16 endianness check: %i", bom_endian);
|
|
|
|
if(bom_endian == -1) /* little-endian */
|
|
{
|
|
high = 1; /* The second byte is the high byte. */
|
|
low = 0; /* The first byte is the low byte. */
|
|
}
|
|
|
|
n = (l/2)*2; /* number bytes that make up full pairs */
|
|
|
|
/* first: get length, check for errors -- stop at first one */
|
|
for(i=0; i < n; i+=2)
|
|
{
|
|
unsigned long point = ((unsigned long) s[i+high]<<8) + s[i+low];
|
|
if((point & 0xfc00) == 0xd800) /* lead surrogate */
|
|
{
|
|
unsigned short second = (i+3 < l) ? (s[i+2+high]<<8) + s[i+2+low] : 0;
|
|
if((second & 0xfc00) == 0xdc00) /* good... */
|
|
{
|
|
point = FULLPOINT(point,second);
|
|
length += UTF8LEN(point); /* possibly 4 bytes */
|
|
i+=2; /* We overstepped one word. */
|
|
}
|
|
else /* if no valid pair, break here */
|
|
{
|
|
if(noquiet) error2("Invalid UTF16 surrogate pair at %li (0x%04lx).", (unsigned long)i, point);
|
|
n = i; /* Forget the half pair, END! */
|
|
break;
|
|
}
|
|
}
|
|
else length += UTF8LEN(point); /* 1,2 or 3 bytes */
|
|
}
|
|
|
|
if(!mpg123_resize_string(sb, length+1)){ mpg123_free_string(sb); return ; }
|
|
|
|
/* Now really convert, skip checks as these have been done just before. */
|
|
p = (unsigned char*) sb->p; /* Signedness doesn't matter but it shows I thought about the non-issue */
|
|
for(i=0; i < n; i+=2)
|
|
{
|
|
unsigned long codepoint = ((unsigned long) s[i+high]<<8) + s[i+low];
|
|
if((codepoint & 0xfc00) == 0xd800) /* lead surrogate */
|
|
{
|
|
unsigned short second = (s[i+2+high]<<8) + s[i+2+low];
|
|
codepoint = FULLPOINT(codepoint,second);
|
|
i+=2; /* We overstepped one word. */
|
|
}
|
|
if(codepoint < 0x80) *p++ = (unsigned char) codepoint;
|
|
else if(codepoint < 0x800)
|
|
{
|
|
*p++ = (unsigned char) (0xc0 | (codepoint>>6));
|
|
*p++ = (unsigned char) (0x80 | (codepoint & 0x3f));
|
|
}
|
|
else if(codepoint < 0x10000)
|
|
{
|
|
*p++ = (unsigned char) (0xe0 | (codepoint>>12));
|
|
*p++ = 0x80 | ((codepoint>>6) & 0x3f);
|
|
*p++ = 0x80 | (codepoint & 0x3f);
|
|
}
|
|
else if (codepoint < 0x200000)
|
|
{
|
|
*p++ = (unsigned char) (0xf0 | codepoint>>18);
|
|
*p++ = (unsigned char) (0x80 | ((codepoint>>12) & 0x3f));
|
|
*p++ = (unsigned char) (0x80 | ((codepoint>>6) & 0x3f));
|
|
*p++ = (unsigned char) (0x80 | (codepoint & 0x3f));
|
|
} /* ignore bigger ones (that are not possible here anyway) */
|
|
}
|
|
sb->p[sb->size-1] = 0; /* paranoia... */
|
|
sb->fill = sb->size;
|
|
}
|
|
#undef UTF8LEN
|
|
#undef FULLPOINT
|
|
|
|
static void convert_utf8(mpg123_string *sb, const unsigned char* source, size_t len, const int noquiet)
|
|
{
|
|
if(mpg123_resize_string(sb, len+1))
|
|
{
|
|
memcpy(sb->p, source, len);
|
|
sb->p[len] = 0;
|
|
sb->fill = len+1;
|
|
}
|
|
else mpg123_free_string(sb);
|
|
}
|
|
|
|
#endif
|