Back to index

eyed3  0.6.18
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions
frames.LyricsFrame Class Reference
Inheritance diagram for frames.LyricsFrame:
Inheritance graph
[legend]
Collaboration diagram for frames.LyricsFrame:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def render
def __unicode__
def __str__
def unsync
def deunsync
def decompress
def compress
def decrypt
def encrypt
def disassembleFrame
def assembleFrame
def getFrameDesc
def getTextDelim

Public Attributes

 encoding
 lang
 description
 lyrics
 header
 decompressedSize
 groupId
 encryptionMethod
 dataLen
 unsync_default

Static Public Attributes

string lang = ""
string description = u""
string lyrics = u""

Private Member Functions

def _set

Detailed Description

Definition at line 1127 of file frames.py.


Constructor & Destructor Documentation

def frames.LyricsFrame.__init__ (   self,
  frameHeader,
  data = None,
  lang = "",
  description = u"",
  lyrics = u"",
  encoding = DEFAULT_ENCODING,
  unsync_default = False 
)

Definition at line 1137 of file frames.py.

01137 
01138                 unsync_default=False):
01139        Frame.__init__(self, frameHeader, unsync_default)
01140        if data != None:
01141            self._set(data, frameHeader)
01142        else:
01143            assert(isinstance(description, unicode))
01144            assert(isinstance(lyrics, unicode))
01145            assert(isinstance(lang, str))
01146            self.encoding = encoding
01147            self.lang = lang
01148            self.description = description
01149            self.lyrics = lyrics

Here is the call graph for this function:


Member Function Documentation

def frames.Frame.__str__ (   self) [inherited]

Reimplemented in frames.URLFrame.

Definition at line 586 of file frames.py.

00586 
00587    def __str__(self):
00588       desc = self.getFrameDesc();
00589       return '<%s Frame (%s)>' % (desc, self.header.id);

Here is the call graph for this function:

Definition at line 1203 of file frames.py.

01203 
01204    def __unicode__(self):
01205       return u"<%s (%s): %s [Lang: %s] [Desc: %s]>" %\
01206              (self.getFrameDesc(), self.header.id, self.lyrics,
01207               self.lang, self.description)

Here is the call graph for this function:

def frames.LyricsFrame._set (   self,
  data,
  frameHeader = None 
) [private]

Definition at line 1153 of file frames.py.

01153 
01154    def _set(self, data, frameHeader = None):
01155       assert(frameHeader)
01156       if not LYRICS_FRAME_RX.match(frameHeader.id):
01157          raise FrameException("Invalid frame id for LyricsFrame: " +\
01158                               frameHeader.id)
01159 
01160       data = self.disassembleFrame(data)
01161       self.encoding = data[0]
01162       TRACE_MSG("LyricsFrame encoding: " + id3EncodingToString(self.encoding))
01163       try:
01164           self.lang = str(data[1:4]).strip("\x00")
01165           # Test ascii encoding
01166           temp_lang = encodeUnicode(self.lang, "ascii")
01167           if self.lang and \
01168              not re.compile("[A-Z][A-Z][A-Z]", re.IGNORECASE).match(self.lang):
01169              if strictID3():
01170                  raise FrameException("[LyricsFrame] Invalid language "\
01171                                        "code: %s" % self.lang)
01172       except UnicodeDecodeError, ex:
01173           if strictID3():
01174               raise FrameException("[LyricsFrame] Invalid language code: "\
01175                                    "[%s] %s" % (ex.object, ex.reason))
01176           else:
01177               self.lang = "";
01178       try:
01179          (d, c) = splitUnicode(data[4:], self.encoding)
01180          self.description = encodeUnicode(d, id3EncodingToString(self.encoding))
01181          self.lyrics = encodeUnicode(c, id3EncodingToString(self.encoding))
01182       except ValueError:
01183           if strictID3():
01184               raise FrameException("Invalid lyrics; no description/lyrics")
01185           else:
01186               self.description = u""
01187               self.lyrics = u""
01188       if not strictID3():
01189           self.description = cleanNulls(self.description)
01190           self.lyrics = cleanNulls(self.lyrics)

Here is the call graph for this function:

Here is the caller graph for this function:

def frames.Frame.assembleFrame (   self,
  data 
) [inherited]

Definition at line 659 of file frames.py.

00659 
00660    def assembleFrame (self, data):
00661       formatFlagData = "";
00662       if self.header.minorVersion == 3:
00663          if self.header.compressed:
00664             formatFlagData += bin2bytes(dec2bin(len(data), 32));
00665          if self.header.encrypted:
00666             formatFlagData += bin2bytes(dec2bin(self.encryptionMethod, 8));
00667          if self.header.grouped:
00668             formatFlagData += bin2bytes(dec2bin(self.groupId, 8));
00669       else:
00670          if self.header.grouped:
00671             formatFlagData += bin2bytes(dec2bin(self.groupId, 8));
00672          if self.header.encrypted:
00673             formatFlagData += bin2bytes(dec2bin(self.encryptionMethod, 8));
00674          if self.header.compressed or self.header.dataLenIndicator:
00675             # Just in case, not sure about this?
00676             self.header.dataLenIndicator = 1;
00677             formatFlagData += bin2bytes(dec2bin(len(data), 32));
00678 
00679       if self.header.compressed:
00680           data = self.compress(data);
00681       if self.header.encrypted:
00682           data = self.encrypt(data);
00683       if self.header.unsync or self.unsync_default:
00684           data = self.unsync(data)
00685 
00686       data = formatFlagData + data;
00687       return self.header.render(len(data)) + data;

Here is the call graph for this function:

Here is the caller graph for this function:

def frames.Frame.compress (   self,
  data 
) [inherited]

Definition at line 604 of file frames.py.

00604 
00605    def compress(self, data):
00606       TRACE_MSG("before compression: %d bytes" % len(data));
00607       data = zlib.compress(data);
00608       TRACE_MSG("after compression: %d bytes" % len(data));
00609       return data;

Here is the call graph for this function:

Here is the caller graph for this function:

def frames.Frame.decompress (   self,
  data 
) [inherited]

Definition at line 598 of file frames.py.

00598 
00599    def decompress(self, data):
00600       TRACE_MSG("before decompression: %d bytes" % len(data));
00601       data = zlib.decompress(data, 15, self.decompressedSize);
00602       TRACE_MSG("after decompression: %d bytes" % len(data));
00603       return data;

Here is the call graph for this function:

Here is the caller graph for this function:

def frames.Frame.decrypt (   self,
  data 
) [inherited]

Definition at line 610 of file frames.py.

00610 
00611    def decrypt(self, data):
00612       raise FrameException("Encryption not supported");

Here is the caller graph for this function:

def frames.Frame.deunsync (   self,
  data 
) [inherited]

Definition at line 594 of file frames.py.

00594 
00595    def deunsync(self, data):
00596        data = deunsyncData(data)
00597        return data

Here is the call graph for this function:

Here is the caller graph for this function:

def frames.Frame.disassembleFrame (   self,
  data 
) [inherited]

Definition at line 616 of file frames.py.

00616 
00617    def disassembleFrame(self, data):
00618       # Format flags in the frame header may add extra data to the
00619       # beginning of this data.
00620       if self.header.minorVersion <= 3:
00621          # 2.3:  compression(4), encryption(1), group(1) 
00622          if self.header.compressed:
00623             self.decompressedSize = bin2dec(bytes2bin(data[:4]));
00624             data = data[4:];
00625             TRACE_MSG("Decompressed Size: %d" % self.decompressedSize);
00626          if self.header.encrypted:
00627             self.encryptionMethod = bin2dec(bytes2bin(data[0]));
00628             data = data[1:];
00629             TRACE_MSG("Encryption Method: %d" % self.encryptionMethod);
00630          if self.header.grouped:
00631             self.groupId = bin2dec(bytes2bin(data[0]));
00632             data = data[1:];
00633             TRACE_MSG("Group ID: %d" % self.groupId);
00634       else:
00635          # 2.4:  group(1), encrypted(1), dataLenIndicator(4,7)
00636          if self.header.grouped:
00637             self.groupId = bin2dec(bytes2bin(data[0]));
00638             data = data[1:];
00639          if self.header.encrypted:
00640             self.encryptionMethod = bin2dec(bytes2bin(data[0]));
00641             data = data[1:];
00642             TRACE_MSG("Encryption Method: %d" % self.encryptionMethod);
00643             TRACE_MSG("Group ID: %d" % self.groupId);
00644          if self.header.dataLenIndicator:
00645             self.dataLen = bin2dec(bytes2bin(data[:4], 7));
00646             data = data[4:];
00647             TRACE_MSG("Data Length: %d" % self.dataLen);
00648             if self.header.compressed:
00649                self.decompressedSize = self.dataLen;
00650                TRACE_MSG("Decompressed Size: %d" % self.decompressedSize);
00651 
00652       if self.header.unsync or self.unsync_default:
00653          data = self.deunsync(data)
00654       if self.header.encrypted:
00655          data = self.decrypt(data);
00656       if self.header.compressed:
00657          data = self.decompress(data);
00658       return data;

Here is the call graph for this function:

Here is the caller graph for this function:

def frames.Frame.encrypt (   self,
  data 
) [inherited]

Definition at line 613 of file frames.py.

00613 
00614    def encrypt(self, data):
00615       raise FrameException("Encryption not supported");

Here is the caller graph for this function:

def frames.Frame.getFrameDesc (   self) [inherited]

Definition at line 688 of file frames.py.

00688 
00689    def getFrameDesc(self):
00690       try:
00691          return frameDesc[self.header.id];
00692       except KeyError:
00693          try:
00694             return obsoleteFrames[self.header.id];
00695          except KeyError:
00696             return "UNKOWN FRAME";

Here is the caller graph for this function:

def frames.Frame.getTextDelim (   self) [inherited]

Definition at line 697 of file frames.py.

00697 
00698    def getTextDelim(self):
00699        if self.encoding == UTF_16_ENCODING or \
00700           self.encoding == UTF_16BE_ENCODING:
00701            return "\x00\x00";
00702        else:
00703            return "\x00";

Here is the caller graph for this function:

def frames.LyricsFrame.render (   self)

Definition at line 1191 of file frames.py.

01191 
01192    def render(self):
01193       lang = self.lang.encode("ascii")
01194       if len(lang) > 3:
01195           lang = lang[0:3]
01196       elif len(lang) < 3:
01197           lang = lang + ('\x00' * (3 - len(lang)))
01198       data = self.encoding + lang +\
01199              self.description.encode(id3EncodingToString(self.encoding)) +\
01200              self.getTextDelim() +\
01201              self.lyrics.encode(id3EncodingToString(self.encoding))
01202       return self.assembleFrame(data)

Here is the call graph for this function:

def frames.Frame.unsync (   self,
  data 
) [inherited]

Definition at line 590 of file frames.py.

00590 
00591    def unsync(self, data):
00592        data = unsyncData(data)
00593        return data

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

frames.Frame.dataLen [inherited]

Definition at line 581 of file frames.py.

Definition at line 578 of file frames.py.

string frames.LyricsFrame.description = u"" [static]

Definition at line 1129 of file frames.py.

Definition at line 1147 of file frames.py.

Reimplemented from frames.Frame.

Definition at line 1145 of file frames.py.

Definition at line 580 of file frames.py.

frames.Frame.groupId [inherited]

Definition at line 579 of file frames.py.

frames.Frame.header [inherited]

Definition at line 577 of file frames.py.

string frames.LyricsFrame.lang = "" [static]

Definition at line 1128 of file frames.py.

Definition at line 1146 of file frames.py.

string frames.LyricsFrame.lyrics = u"" [static]

Definition at line 1130 of file frames.py.

Definition at line 1148 of file frames.py.

Definition at line 584 of file frames.py.


The documentation for this class was generated from the following file: