1 files changed, 310 insertions, 122 deletions

diff --git a/src/plugins/id3v24_extractor.c b/src/plugins/id3v24_extractor.c
index ec11e4a..acc76af 100644
--- a/src/plugins/id3v24_extractor.c
+++ b/src/plugins/id3v24_extractor.c
@@ -1,6 +1,6 @@
 /*
      This file is part of libextractor.
-     (C) 2002, 2003, 2004, 2006, 2009 Vidyut Samanta and Christian Grothoff
+     (C) 2002, 2003, 2004, 2006, 2007, 2009 Vidyut Samanta and Christian Grothoff
 
      libextractor is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -18,7 +18,6 @@
      Boston, MA 02111-1307, USA.
 
  */
-
 #define DEBUG_EXTRACT_ID3v24 0
 
 #include "platform.h"
@@ -33,72 +32,98 @@
 #ifndef MINGW
 #include <sys/mman.h>
 #endif
+
 #include "convert.h"
 
-
-static struct EXTRACTOR_Keywords *
-addKeyword (EXTRACTOR_KeywordList * oldhead,
-            char *phrase, EXTRACTOR_KeywordType type)
-{
-  EXTRACTOR_KeywordList *keyword;
-
-  keyword = malloc (sizeof (EXTRACTOR_KeywordList));
-  keyword->next = oldhead;
-  keyword->keyword = phrase;
-  keyword->keywordType = type;
-  return keyword;
-}
+enum Id3v24Fmt
+  {
+    T, /* simple, 0-terminated string, prefixed by encoding */
+    U, /* 0-terminated ASCII string, no encoding */
+    UL, /* unsync'ed lyrics */
+    SL, /* sync'ed lyrics */
+    L, /* string with language prefix */
+    I /* image */
+  };
 
 typedef struct
 {
-  char *text;
+  const char *text;
   enum EXTRACTOR_MetaType type;
+  enum Id3v24Fmt fmt;
 } Matches;
 
 static Matches tmap[] = {
-  {"COMM", EXTRACTOR_METATYPE_COMMENT},
-  {"IPLS", EXTRACTOR_METATYPE_CONTRIBUTOR},
-  {"TIPL", EXTRACTOR_METATYPE_CONTRIBUTOR},
-  {"TMOO", EXTRACTOR_METATYPE_MOOD},
-  {"TMCL", EXTRACTOR_METATYPE_MUSICIAN_CREDITS_LIST},
-  {"LINK", EXTRACTOR_METATYPE_LINK},
-  {"MCDI", EXTRACTOR_METATYPE_MUSIC_CD_IDENTIFIER},
-  {"PCNT", EXTRACTOR_METATYPE_PLAY_COUNTER},
-  {"POPM", EXTRACTOR_METATYPE_POPULARITY_METER},
-  {"TCOP", EXTRACTOR_METATYPE_COPYRIGHT},
-  {"TDRC", EXTRACTOR_METATYPE_DATE},
-  {"TCON", EXTRACTOR_METATYPE_GENRE},
-  {"TIT1", EXTRACTOR_METATYPE_GENRE},
-  {"TENC", EXTRACTOR_METATYPE_ENCODED_BY},
-  {"TEXT", EXTRACTOR_METATYPE_LYRICS},
-  {"TOLY", EXTRACTOR_METATYPE_CONTRIBUTOR},
-  {"TOPE", EXTRACTOR_METATYPE_CONTRIBUTOR},
-  {"TOWN", EXTRACTOR_METATYPE_OWNER},
-  {"TPE1", EXTRACTOR_METATYPE_ARTIST},
-  {"TPE2", EXTRACTOR_METATYPE_ARTIST},
-  {"TPE3", EXTRACTOR_METATYPE_CONDUCTOR},
-  {"TPE4", EXTRACTOR_METATYPE_INTERPRET},
-  {"TIME", EXTRACTOR_METATYPE_TIME},
-  {"TMED", EXTRACTOR_METATYPE_MEDIA_TYPE},
-  {"TCOM", EXTRACTOR_METATYPE_CREATOR},
-  {"TOFN", EXTRACTOR_METATYPE_FILENAME},
-  {"TOPE", EXTRACTOR_METATYPE_ARTIST},
-  {"TPUB", EXTRACTOR_METATYPE_PUBLISHER},
-  {"TRCK", EXTRACTOR_METATYPE_TRACK_NUMBER},
-  {"TRSC", EXTRACTOR_METATYPE_ISRC},
-  {"TRSN", EXTRACTOR_METATYPE_SOURCE},
-  {"TRSO", EXTRACTOR_METATYPE_CREATED_FOR},
-  {"TSRC", EXTRACTOR_METATYPE_RESOURCE_IDENTIFIER},
-  {"TYER", EXTRACTOR_METATYPE_YEAR},
-  {"TOAL", EXTRACTOR_METATYPE_ALBUM},
-  {"TALB", EXTRACTOR_METATYPE_ALBUM},
-  {"TLAN", EXTRACTOR_METATYPE_LANGUAGE},
-  {"TIT2", EXTRACTOR_METATYPE_TITLE},
-  {"TIT3", EXTRACTOR_METATYPE_DESCRIPTION},
-  {"WCOM", EXTRACTOR_METATYPE_RELEASE},
-  {"WCOP", EXTRACTOR_METATYPE_DISCLAIMER},
-  {"", EXTRACTOR_METATYPE_KEYWORDS},
-  {NULL, 0}
+  {"TALB", EXTRACTOR_METATYPE_ALBUM, T},
+  {"TBPM", EXTRACTOR_METATYPE_BEATS_PER_MINUTE, T},
+  {"TCOM", EXTRACTOR_METATYPE_COMPOSER, T},
+  {"TCON", EXTRACTOR_METATYPE_SONG_VERSION, T},
+  {"TCOP", EXTRACTOR_METATYPE_COPYRIGHT, T},
+  /* {"TDAT", EXTRACTOR_METATYPE_CREATION_DATE, T}, deprecated in 24 */
+  /* TDLY */
+  {"TENC", EXTRACTOR_METATYPE_ENCODED_BY, T},
+  {"TEXT", EXTRACTOR_METATYPE_WRITER, T},  
+  {"TFLT", EXTRACTOR_METATYPE_FORMAT_VERSION, T},
+  /* TIME, deprecated in 24 */
+  {"TIT1", EXTRACTOR_METATYPE_SECTION, T},
+  {"TIT2", EXTRACTOR_METATYPE_TITLE, T},
+  {"TIT3", EXTRACTOR_METATYPE_SONG_VERSION, T},
+  /* TKEY */
+  {"TLAN", EXTRACTOR_METATYPE_LANGUAGE, T},
+  {"TLEN", EXTRACTOR_METATYPE_DURATION, T}, /* FIXME: should append 'ms' as unit */
+  {"TMED", EXTRACTOR_METATYPE_SOURCE, T}, 
+  {"TOAL", EXTRACTOR_METATYPE_ORIGINAL_TITLE, T},
+  {"TOFN", EXTRACTOR_METATYPE_ORIGINAL_ARTIST, T},
+  {"TOLY", EXTRACTOR_METATYPE_ORIGINAL_WRITER, T},
+  {"TOPE", EXTRACTOR_METATYPE_ORIGINAL_PERFORMER, T},
+  /* {"TORY", EXTRACTOR_METATYPE_ORIGINAL_RELEASE_YEAR, T}, deprecated in 24 */
+  {"TOWN", EXTRACTOR_METATYPE_LICENSEE, T},
+  {"TPE1", EXTRACTOR_METATYPE_ARTIST, T},
+  {"TPE2", EXTRACTOR_METATYPE_PERFORMER, T},
+  {"TPE3", EXTRACTOR_METATYPE_CONDUCTOR, T},
+  {"TPE4", EXTRACTOR_METATYPE_INTERPRETATION, T}, 
+  {"TPOS", EXTRACTOR_METATYPE_DISC_NUMBER, T},
+  {"TPUB", EXTRACTOR_METATYPE_PUBLISHER, T},
+  {"TRCK", EXTRACTOR_METATYPE_TRACK_NUMBER, T},
+  /* TRDA, deprecated in 24 */
+  {"TRSN", EXTRACTOR_METATYPE_NETWORK_NAME, T},
+  /* TRSO */
+  /* {"TSIZ", EXTRACTOR_METATYPE_EMBEDDED_FILE_SIZE, T}, deprecated in 24 */
+  {"TSRC", EXTRACTOR_METATYPE_ISRC, T},
+  /* TSSE */
+  /* {"TYER", EXTRACTOR_METATYPE_PUBLICATION_YEAR, T}, deprecated in 24 */
+  {"WCOM", EXTRACTOR_METATYPE_URL, U},
+  {"WCOP", EXTRACTOR_METATYPE_URL, U},
+  {"WOAF", EXTRACTOR_METATYPE_URL, U},
+  {"WOAS", EXTRACTOR_METATYPE_URL, U},
+  {"WORS", EXTRACTOR_METATYPE_URL, U},
+  {"WPAY", EXTRACTOR_METATYPE_URL, U},
+  {"WPUB", EXTRACTOR_METATYPE_URL, U},
+  {"WXXX", EXTRACTOR_METATYPE_URL, T},
+  /* {"IPLS", EXTRACTOR_METATYPE_CONTRIBUTOR_NAME, T}, deprecated in 24 */
+  /* ... */
+  {"USLT", EXTRACTOR_METATYPE_LYRICS, UL },
+  {"SYLT", EXTRACTOR_METATYPE_LYRICS, SL },
+  {"COMM", EXTRACTOR_METATYPE_COMMENT, L},
+  /* ... */
+  {"APIC", EXTRACTOR_METATYPE_PICTURE, I},
+  /* ... */
+  {"LINK", EXTRACTOR_METATYPE_URL, U},
+  /* ... */
+  {"USER", EXTRACTOR_METATYPE_LICENSE, T},
+  /* ... */
+  /* new frames in 24 */
+  /* ASPI, EQU2, RVA2, SEEK, SIGN, TDEN */
+  {"TDOR", EXTRACTOR_METATYPE_PUBLICATION_DATE, T},
+  /* TDRC, TDRL, TDTG */
+  {"TIPL", EXTRACTOR_METATYPE_CONTRIBUTOR_NAME, T},
+  {"TMCL", EXTRACTOR_METATYPE_MUSICIAN_CREDITS_LIST, T},
+  {"TMOO", EXTRACTOR_METATYPE_MOOD, T},
+  {"TPRO", EXTRACTOR_METATYPE_COPYRIGHT, T},
+  {"TSOA", EXTRACTOR_METATYPE_ALBUM, T},
+  {"TSOP", EXTRACTOR_METATYPE_PERFORMER, T},
+  {"TSOT", EXTRACTOR_METATYPE_TITLE, T},
+  {"TSST", EXTRACTOR_METATYPE_SUBTITLE, T},
+  {NULL, 0, T}
 };
 
 
@@ -114,54 +139,60 @@ EXTRACTOR_id3v24_extract (const unsigned char *data,
   int extendedHdr;
   int experimental;
   int footer;
-  unsigned int tsize;
-  unsigned int pos;
-  unsigned int ehdrSize;
-  unsigned int padding;
+  uint32_t tsize;
+  uint32_t pos;
+  uint32_t ehdrSize;
+  uint32_t padding;
+  uint32_t csize;
+  int i;
+  uint16_t flags;
+  char *mime;
+  enum EXTRACTOR_MetaType type;
+  size_t off;
 
   if ((size < 16) ||
       (data[0] != 0x49) ||
       (data[1] != 0x44) ||
       (data[2] != 0x33) || (data[3] != 0x04) || (data[4] != 0x00))
-    return prev;
+    return 0;
   unsync = (data[5] & 0x80) > 0;
+  if (unsync)
+    return 0; /* not supported */
   extendedHdr = (data[5] & 0x40) > 0;
   experimental = (data[5] & 0x20) > 0;
+  if (experimental)
+    return 0;
   footer = (data[5] & 0x10) > 0;
   tsize = (((data[6] & 0x7F) << 21) |
            ((data[7] & 0x7F) << 14) |
            ((data[8] & 0x7F) << 7) | ((data[9] & 0x7F) << 0));
-  if ((tsize + 10 > size) || (experimental))
-    return prev;
+  if (tsize + 10 > size)
+    return 0;
   pos = 10;
   padding = 0;
   if (extendedHdr)
     {
       ehdrSize = (((data[10] & 0x7F) << 21) |
-                  ((data[11] & 0x7F) << 14) |
-                  ((data[12] & 0x7F) << 7) | ((data[13] & 0x7F) << 0));
-      pos += ehdrSize;
+                  ((data[11] & 0x7F) << 14) |
+                  ((data[12] & 0x7F) << 7) | ((data[13] & 0x7F) << 0));
+      pos += 4 + ehdrSize;
+      if (ehdrSize > tsize)
+        return 0;
     }
-
-
   while (pos < tsize)
     {
-      size_t csize;
-      int i;
-      unsigned short flags;
-
       if (pos + 10 > tsize)
-        return prev;
-
-      csize = (((data[pos + 4] & 0x7F) << 21) |
-               ((data[pos + 5] & 0x7F) << 14) |
-               ((data[pos + 6] & 0x7F) << 7) | ((data[pos + 7] & 0x7F) << 0));
-
-      if ((pos + 10 + csize > tsize) || (csize > tsize) || (csize == 0))
+        return 0;
+      csize =
+        (data[pos + 4] << 24) + (data[pos + 5] << 16) + (data[pos + 6] << 8) +
+        data[pos + 7];
+      if ((pos + 10 + csize > tsize) || (csize > tsize) || (csize == 0) ||
+          (pos + 10 + csize <= pos + 10) || (pos + 10 <= pos))
         break;
       flags = (data[pos + 8] << 8) + data[pos + 9];
-      if (((flags & 0x80) > 0) /* compressed, not yet supported */  ||
-          ((flags & 0x40) > 0) /* encrypted, not supported */ )
+      if (((flags & 0x08) > 0) /* compressed, not yet supported */  ||
+          ((flags & 0x04) > 0) /* encrypted, not supported */ ||
+          ((flags & 0x02) > 0) /* unsynchronized, not supported */ )
         {
           pos += 10 + csize;
           continue;
@@ -172,59 +203,216 @@ EXTRACTOR_id3v24_extract (const unsigned char *data,
           if (0 == strncmp (tmap[i].text, (const char *) &data[pos], 4))
             {
               char *word;
-              if ((flags & 0x20) > 0)
+              if ((flags & 0x40) > 0)
                 {
                   /* "group" identifier, skip a byte */
                   pos++;
                   csize--;
                 }
 
-              /* this byte describes the encoding
-                 try to convert strings to UTF-8
-                 if it fails, then forget it */
-              csize--;
-              switch (data[pos + 10])
-                {
-                case 0x00:
-                  word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 11],
-                                        csize, "ISO-8859-1");
-                  break;
-                case 0x01:
-                  word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 11],
-                                        csize, "UTF-16");
-                  break;
-                case 0x02:
-                  word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 11],
-                                        csize, "UTF-16BE");
-                  break;
-                case 0x03:
-                  word = malloc (csize + 1);
-                  memcpy (word, &data[pos + 11], csize);
-                  word[csize] = '\0';
-                  break;
-                default:
-                  /* bad encoding byte,
-                     try to convert from iso-8859-1 */
-                  word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 11],
-                                        csize, "ISO-8859-1");
-                  break;
-                }
-              pos++;
+              switch (tmap[i].fmt)
+                {
+                case T:
+                  /* this byte describes the encoding
+                     try to convert strings to UTF-8
+                     if it fails, then forget it */
+                  switch (data[pos + 10])
+                    {
+                    case 0x00:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 11],
+                                                               csize - 1, "ISO-8859-1");
+                      break;
+                    case 0x01:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 11],
+                                                               csize - 1, "UCS-2");
+                      break;
+                    default:
+                      /* bad encoding byte,
+                         try to convert from iso-8859-1 */
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 11],
+                                                               csize - 1, "ISO-8859-1");
+                      break;
+                    }
+                  break;
+                case U:
+                  word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 10],
+                                                           csize, "ISO-8859-1");
+                  break;
+                case UL:
+                  if (csize < 6)
+                    return 0; /* malformed */
+                  /* find end of description */
+                  off = 14;
+                  while ( (off < size) &&
+                          (off - pos < csize) &&
+                          (data[pos + off] == '\0') )
+                    off++;
+                  if ( (off >= csize) ||
+                       (data[pos+off] != '\0') )
+                    return 0; /* malformed */
+                  off++;
+                  switch (data[pos + 10])
+                    {
+                    case 0x00:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + off],
+                                                               csize - off, "ISO-8859-1");
+                      break;
+                    case 0x01:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + off],
+                                                               csize - off, "UCS-2");
+                      break;
+                    default:
+                      /* bad encoding byte,
+                         try to convert from iso-8859-1 */
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + off],
+                                                               csize - off, "ISO-8859-1");
+                      break;
+                    }
+                  break;
+                case SL:
+                  if (csize < 7)
+                    return 0; /* malformed */
+                  /* find end of description */
+                  switch (data[pos + 10])
+                    {
+                    case 0x00:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 16],
+                                                               csize - 6, "ISO-8859-1");
+                      break;
+                    case 0x01:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 16],
+                                                               csize - 6, "UCS-2");
+                      break;
+                    default:
+                      /* bad encoding byte,
+                         try to convert from iso-8859-1 */
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 16],
+                                                               csize - 6, "ISO-8859-1");
+                      break;
+                    }
+                  break;
+                case L:
+                  if (csize < 5)
+                    return 0; /* malformed */
+                  /* find end of description */
+                  switch (data[pos + 10])
+                    {
+                    case 0x00:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 14],
+                                                               csize - 4, "ISO-8859-1");
+                      break;
+                    case 0x01:
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 14],
+                                                               csize - 4, "UCS-2");
+                      break;
+                    default:
+                      /* bad encoding byte,
+                         try to convert from iso-8859-1 */
+                      word = EXTRACTOR_common_convert_to_utf8 ((const char *) &data[pos + 14],
+                                                               csize - 4, "ISO-8859-1");
+                      break;
+                    }
+                  break;
+                case I:
+                  if (csize < 2)
+                    return 0; /* malformed */
+                  /* find end of mime type */
+                  off = 11;
+                  while ( (off < size) &&
+                          (off - pos < csize) &&
+                          (data[pos + off] == '\0') )
+                    off++;
+                  if ( (off >= csize) ||
+                       (data[pos+off] != '\0') )
+                    return 0; /* malformed */
+                  off++;
+                  mime = strdup ((const char*) &data[pos + 11]);
+                  
+                  switch (data[pos+off])
+                    {
+                    case 0x03:
+                    case 0x04:
+                      type = EXTRACTOR_METATYPE_COVER_PICTURE;
+                      break;
+                    case 0x07:
+                    case 0x08:
+                    case 0x09:
+                    case 0x0A:
+                    case 0x0B:
+                    case 0x0C:
+                      type = EXTRACTOR_METATYPE_CONTRIBUTOR_PICTURE;
+                      break;
+                    case 0x0D:
+                    case 0x0E:
+                    case 0x0F:
+                      type = EXTRACTOR_METATYPE_EVENT_PICTURE;
+                      break;
+                    case 0x14:
+                      type = EXTRACTOR_METATYPE_LOGO;
+                      type = EXTRACTOR_METATYPE_LOGO;
+                      break;
+                    default:
+                      type = EXTRACTOR_METATYPE_PICTURE;
+                      break;
+                    }
+                  off++;
+
+                  /* find end of description */
+                  while ( (off < size) &&
+                          (off - pos < csize) &&
+                          (data[pos + off] == '\0') )
+                    off++;
+                  if ( (off >= csize) ||
+                       (data[pos+off] != '\0') )
+                    return 0; /* malformed */
+                  off++;
+                  if (0 == strcasecmp ("-->",
+                                       mime))
+                    {
+                      /* not supported */
+                    }
+                  else
+                    {
+                      if (0 != proc (proc_cls,
+                                     "id3v24",
+                                     type,
+                                     EXTRACTOR_METAFORMAT_BINARY,
+                                     mime,
+                                     (const char*) &data[pos + off],
+                                     csize + 6 - off))                  
+                        {
+                          free (mime);
+                          return 1;
+                        }
+                    }
+                  free (mime);
+                  word = NULL;
+                  break;
+                default:
+                  return 0;
+                }             
               if ((word != NULL) && (strlen (word) > 0))
                 {
-                  prev = addKeyword (prev, word, tmap[i].type);
-                }
-              else
-                {
-                  free (word);
+                  if (0 != proc (proc_cls,
+                                 "id3v24",
+                                 tmap[i].type,
+                                 EXTRACTOR_METAFORMAT_UTF8,
+                                 "text/plain",
+                                 word,
+                                 strlen(word)+1))
+                    {
+                      free (word);
+                      return 1;
+                    }
                 }
+              free (word);
               break;
             }
           i++;
         }
       pos += 10 + csize;
     }
-  return prev;
+  return 0;
 }
 
 /* end of id3v24_extractor.c */