Subliminal update

libs/enzyme/riff.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 # enzyme - Video metadata parser
-# Copyright (C) 2011 Antoine Bertin <diaoulael@gmail.com>
-# Copyright (C) 2003-2006 Thomas Schueppel <stain@acm.org>
-# Copyright (C) 2003-2006 Dirk Meyer <dischi@freevo.org>
+# Copyright 2011-2012 Antoine Bertin <diaoulael@gmail.com>
+# Copyright 2003-2006 Thomas Schueppel <stain@acm.org>
+# Copyright 2003-2006 Dirk Meyer <dischi@freevo.org>
 #
 # This file is part of enzyme.
 #
@@ -17,9 +17,7 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-
+# along with enzyme.  If not, see <http://www.gnu.org/licenses/>.
 __all__ = ['Parser']
 
 import os
@@ -27,7 +25,7 @@ import struct
 import string
 import logging
 import time
-from exceptions import *
+from exceptions import ParseError
 import core
 
 # get logging object
@@ -70,7 +68,7 @@ class Riff(core.AVContainer):
     """
     table_mapping = { 'AVIINFO' : AVIINFO }
 
-    def __init__(self,file):
+    def __init__(self, file):
         core.AVContainer.__init__(self)
         # read the header
         h = file.read(12)
@@ -90,12 +88,12 @@ class Riff(core.AVContainer):
             while self._parseRIFFChunk(file):
                 pass
         except IOError:
-            log.exception('error in file, stop parsing')
+            log.exception(u'error in file, stop parsing')
 
         self._find_subtitles(file.name)
 
         if not self.has_idx and isinstance(self, core.AVContainer):
-            log.debug('WARNING: avi has no index')
+            log.debug(u'WARNING: avi has no index')
             self._set('corrupt', True)
 
 
@@ -104,9 +102,9 @@ class Riff(core.AVContainer):
         Search for subtitle files. Right now only VobSub is supported
         """
         base = os.path.splitext(filename)[0]
-        if os.path.isfile(base+'.idx') and \
-               (os.path.isfile(base+'.sub') or os.path.isfile(base+'.rar')):
-            file = open(base+'.idx')
+        if os.path.isfile(base + '.idx') and \
+               (os.path.isfile(base + '.sub') or os.path.isfile(base + '.rar')):
+            file = open(base + '.idx')
             if file.readline().find('VobSub index file') > 0:
                 for line in file.readlines():
                     if line.find('id') == 0:
@@ -117,10 +115,10 @@ class Riff(core.AVContainer):
             file.close()
 
 
-    def _parseAVIH(self,t):
+    def _parseAVIH(self, t):
         retval = {}
-        v = struct.unpack('<IIIIIIIIIIIIII',t[0:56])
-        ( retval['dwMicroSecPerFrame'],
+        v = struct.unpack('<IIIIIIIIIIIIII', t[0:56])
+        (retval['dwMicroSecPerFrame'],
           retval['dwMaxBytesPerSec'],
           retval['dwPaddingGranularity'],
           retval['dwFlags'],
@@ -133,22 +131,22 @@ class Riff(core.AVContainer):
           retval['dwScale'],
           retval['dwRate'],
           retval['dwStart'],
-          retval['dwLength'] ) = v
+          retval['dwLength']) = v
         if retval['dwMicroSecPerFrame'] == 0:
-            log.warning("ERROR: Corrupt AVI")
+            log.warning(u'ERROR: Corrupt AVI')
             raise ParseError()
 
         return retval
 
 
-    def _parseSTRH(self,t):
+    def _parseSTRH(self, t):
         retval = {}
         retval['fccType'] = t[0:4]
-        log.debug("_parseSTRH(%s) : %d bytes" % (retval['fccType'], len(t)))
+        log.debug(u'_parseSTRH(%r) : %d bytes' % (retval['fccType'], len(t)))
         if retval['fccType'] != 'auds':
             retval['fccHandler'] = t[4:8]
-            v = struct.unpack('<IHHIIIIIIIII',t[8:52])
-            ( retval['dwFlags'],
+            v = struct.unpack('<IHHIIIIIIIII', t[8:52])
+            (retval['dwFlags'],
               retval['wPriority'],
               retval['wLanguage'],
               retval['dwInitialFrames'],
@@ -159,11 +157,11 @@ class Riff(core.AVContainer):
               retval['dwSuggestedBufferSize'],
               retval['dwQuality'],
               retval['dwSampleSize'],
-              retval['rcFrame'] ) = v
+              retval['rcFrame']) = v
         else:
             try:
-                v = struct.unpack('<IHHIIIIIIIII',t[8:52])
-                ( retval['dwFlags'],
+                v = struct.unpack('<IHHIIIIIIIII', t[8:52])
+                (retval['dwFlags'],
                   retval['wPriority'],
                   retval['wLanguage'],
                   retval['dwInitialFrames'],
@@ -174,7 +172,7 @@ class Riff(core.AVContainer):
                   retval['dwSuggestedBufferSize'],
                   retval['dwQuality'],
                   retval['dwSampleSize'],
-                  retval['rcFrame'] ) = v
+                  retval['rcFrame']) = v
                 self.delay = float(retval['dwStart']) / \
                              (float(retval['dwRate']) / retval['dwScale'])
             except (KeyError, IndexError, ValueError, ZeroDivisionError):
@@ -183,12 +181,12 @@ class Riff(core.AVContainer):
         return retval
 
 
-    def _parseSTRF(self,t,strh):
+    def _parseSTRF(self, t, strh):
         fccType = strh['fccType']
         retval = {}
         if fccType == 'auds':
-            v = struct.unpack('<HHHHHH',t[0:12])
-            ( retval['wFormatTag'],
+            v = struct.unpack('<HHHHHH', t[0:12])
+            (retval['wFormatTag'],
               retval['nChannels'],
               retval['nSamplesPerSec'],
               retval['nAvgBytesPerSec'],
@@ -209,18 +207,18 @@ class Riff(core.AVContainer):
             ai.codec = retval['wFormatTag']
             self.audio.append(ai)
         elif fccType == 'vids':
-            v = struct.unpack('<IIIHH',t[0:16])
-            ( retval['biSize'],
+            v = struct.unpack('<IIIHH', t[0:16])
+            (retval['biSize'],
               retval['biWidth'],
               retval['biHeight'],
               retval['biPlanes'],
-              retval['biBitCount'] ) = v
-            v = struct.unpack('IIIII',t[20:40])
-            ( retval['biSizeImage'],
+              retval['biBitCount']) = v
+            v = struct.unpack('IIIII', t[20:40])
+            (retval['biSizeImage'],
               retval['biXPelsPerMeter'],
               retval['biYPelsPerMeter'],
               retval['biClrUsed'],
-              retval['biClrImportant'] ) = v
+              retval['biClrImportant']) = v
             vi = core.VideoStream()
             vi.codec = t[16:20]
             vi.width = retval['biWidth']
@@ -233,15 +231,15 @@ class Riff(core.AVContainer):
         return retval
 
 
-    def _parseSTRL(self,t):
+    def _parseSTRL(self, t):
         retval = {}
         size = len(t)
         i = 0
 
         while i < len(t) - 8:
-            key = t[i:i+4]
-            sz = struct.unpack('<I',t[i+4:i+8])[0]
-            i+=8
+            key = t[i:i + 4]
+            sz = struct.unpack('<I', t[i + 4:i + 8])[0]
+            i += 8
             value = t[i:]
 
             if key == 'strh':
@@ -249,40 +247,40 @@ class Riff(core.AVContainer):
             elif key == 'strf':
                 retval[key] = self._parseSTRF(value, retval['strh'])
             else:
-                log.debug("_parseSTRL: unsupported stream tag '%s'", key)
+                log.debug(u'_parseSTRL: unsupported stream tag %r', key)
 
             i += sz
 
         return retval, i
 
 
-    def _parseODML(self,t):
+    def _parseODML(self, t):
         retval = {}
         size = len(t)
         i = 0
-        key = t[i:i+4]
-        sz = struct.unpack('<I',t[i+4:i+8])[0]
+        key = t[i:i + 4]
+        sz = struct.unpack('<I', t[i + 4:i + 8])[0]
         i += 8
         value = t[i:]
         if key != 'dmlh':
-            log.debug("_parseODML: Error")
+            log.debug(u'_parseODML: Error')
 
         i += sz - 8
         return (retval, i)
 
 
-    def _parseVPRP(self,t):
+    def _parseVPRP(self, t):
         retval = {}
-        v = struct.unpack('<IIIIIIIIII',t[:4*10])
+        v = struct.unpack('<IIIIIIIIII', t[:4 * 10])
 
-        ( retval['VideoFormat'],
+        (retval['VideoFormat'],
           retval['VideoStandard'],
           retval['RefreshRate'],
           retval['HTotalIn'],
           retval['VTotalIn'],
           retval['FrameAspectRatio'],
           retval['wPixel'],
-          retval['hPixel'] ) = v[1:-1]
+          retval['hPixel']) = v[1:-1]
 
         # I need an avi with more informations
         # enum {FORMAT_UNKNOWN, FORMAT_PAL_SQUARE, FORMAT_PAL_CCIR_601,
@@ -309,7 +307,7 @@ class Riff(core.AVContainer):
         # If the VOL header doesn't appear within 5MB or 5 video chunks,
         # give up.  The 5MB limit is not likely to apply except in
         # pathological cases.
-        while i < min(1024*1024*5, size - 8) and n_dc < 5:
+        while i < min(1024 * 1024 * 5, size - 8) and n_dc < 5:
             data = file.read(8)
             if ord(data[0]) == 0:
                 # Eat leading nulls.
@@ -317,7 +315,7 @@ class Riff(core.AVContainer):
                 i += 1
 
             key, sz = struct.unpack('<4sI', data)
-            if key[2:] != 'dc' or sz > 1024*500:
+            if key[2:] != 'dc' or sz > 1024 * 500:
                 # This chunk is not video or is unusually big (> 500KB);
                 # skip it.
                 file.seek(sz, 1)
@@ -338,7 +336,7 @@ class Riff(core.AVContainer):
             startcode = 0xff
             def bits(v, o, n):
                 # Returns n bits in v, offset o bits.
-                return (v & 2**n-1 << (64-n-o)) >> 64-n-o
+                return (v & 2 ** n - 1 << (64 - n - o)) >> 64 - n - o
 
             while pos < sz:
                 startcode = ((startcode << 8) | ord(data[pos])) & 0xffffffff
@@ -350,7 +348,7 @@ class Riff(core.AVContainer):
                 if startcode >= 0x120 and startcode <= 0x12F:
                     # We have the VOL startcode.  Pull 64 bits of it and treat
                     # as a bitstream
-                    v = struct.unpack(">Q", data[pos : pos+8])[0]
+                    v = struct.unpack(">Q", data[pos : pos + 8])[0]
                     offset = 10
                     if bits(v, 9, 1):
                         # is_ol_id, skip over vo_ver_id and vo_priority
@@ -385,36 +383,36 @@ class Riff(core.AVContainer):
 
         if i < size:
             # Seek past whatever might be remaining of the movi list.
-            file.seek(size-i,1)
+            file.seek(size - i, 1)
 
 
 
-    def _parseLIST(self,t):
+    def _parseLIST(self, t):
         retval = {}
         i = 0
         size = len(t)
 
-        while i < size-8:
+        while i < size - 8:
             # skip zero
             if ord(t[i]) == 0: i += 1
-            key = t[i:i+4]
+            key = t[i:i + 4]
             sz = 0
 
             if key == 'LIST':
-                sz = struct.unpack('<I',t[i+4:i+8])[0]
-                i+=8
-                key = "LIST:"+t[i:i+4]
-                value = self._parseLIST(t[i:i+sz])
+                sz = struct.unpack('<I', t[i + 4:i + 8])[0]
+                i += 8
+                key = "LIST:" + t[i:i + 4]
+                value = self._parseLIST(t[i:i + sz])
                 if key == 'strl':
                     for k in value.keys():
                         retval[k] = value[k]
                 else:
                     retval[key] = value
-                i+=sz
+                i += sz
             elif key == 'avih':
-                sz = struct.unpack('<I',t[i+4:i+8])[0]
+                sz = struct.unpack('<I', t[i + 4:i + 8])[0]
                 i += 8
-                value = self._parseAVIH(t[i:i+sz])
+                value = self._parseAVIH(t[i:i + sz])
                 i += sz
                 retval[key] = value
             elif key == 'strl':
@@ -433,15 +431,15 @@ class Riff(core.AVContainer):
                 retval[key] = value
                 i += sz
             elif key == 'JUNK':
-                sz = struct.unpack('<I',t[i+4:i+8])[0]
+                sz = struct.unpack('<I', t[i + 4:i + 8])[0]
                 i += sz + 8
             else:
-                sz = struct.unpack('<I',t[i+4:i+8])[0]
-                i+=8
+                sz = struct.unpack('<I', t[i + 4:i + 8])[0]
+                i += 8
                 # in most cases this is some info stuff
                 if not key in AVIINFO.keys() and key != 'IDIT':
-                    log.debug("Unknown Key: %s, len: %d" % (key,sz))
-                value = t[i:i+sz]
+                    log.debug(u'Unknown Key: %r, len: %d' % (key, sz))
+                value = t[i:i + sz]
                 if key == 'ISFT':
                     # product information
                     if value.find('\0') > 0:
@@ -466,17 +464,17 @@ class Riff(core.AVContainer):
                             except ValueError:
                                 pass
                         else:
-                            log.debug('no support for time format %s', value)
-                i+=sz
+                            log.debug(u'no support for time format %r', value)
+                i += sz
         return retval
 
 
-    def _parseRIFFChunk(self,file):
+    def _parseRIFFChunk(self, file):
         h = file.read(8)
         if len(h) < 8:
             return False
         name = h[:4]
-        size = struct.unpack('<I',h[4:8])[0]
+        size = struct.unpack('<I', h[4:8])[0]
 
         if name == 'LIST':
             pos = file.tell() - 8
@@ -488,18 +486,18 @@ class Riff(core.AVContainer):
                 # header), but we do know the video's dimensions, and
                 # we're dealing with an mpeg4 stream, try to get the aspect
                 # from the VOL header in the mpeg4 stream.
-                self._parseLISTmovi(size-4, file)
+                self._parseLISTmovi(size - 4, file)
                 return True
             elif size > 80000:
-                log.debug('RIFF LIST "%s" too long to parse: %s bytes' % (key, size))
-                t = file.seek(size-4,1)
+                log.debug(u'RIFF LIST %r too long to parse: %r bytes' % (key, size))
+                t = file.seek(size - 4, 1)
                 return True
             elif size < 5:
-                log.debug('RIFF LIST "%s" too short: %s bytes' % (key, size))
+                log.debug(u'RIFF LIST %r too short: %r bytes' % (key, size))
                 return True
 
-            t = file.read(size-4)
-            log.debug('parse RIFF LIST "%s": %d bytes' % (key, size))
+            t = file.read(size - 4)
+            log.debug(u'parse RIFF LIST %r: %d bytes' % (key, size))
             value = self._parseLIST(t)
             self.header[key] = value
             if key == 'INFO':
@@ -511,7 +509,7 @@ class Riff(core.AVContainer):
                 # no need to add this info to a table
                 pass
             else:
-                log.debug('Skipping table info %s' % key)
+                log.debug(u'Skipping table info %r' % key)
 
         elif name == 'JUNK':
             self.junkStart = file.tell() - 8
@@ -519,15 +517,15 @@ class Riff(core.AVContainer):
             file.seek(size, 1)
         elif name == 'idx1':
             self.has_idx = True
-            log.debug('idx1: %s bytes' % size)
+            log.debug(u'idx1: %r bytes' % size)
             # no need to parse this
-            t = file.seek(size,1)
+            t = file.seek(size, 1)
         elif name == 'RIFF':
-            log.debug("New RIFF chunk, extended avi [%i]" % size)
+            log.debug(u'New RIFF chunk, extended avi [%i]' % size)
             type = file.read(4)
             if type != 'AVIX':
-                log.debug("Second RIFF chunk is %s, not AVIX, skipping", type)
-                file.seek(size-4, 1)
+                log.debug(u'Second RIFF chunk is %r, not AVIX, skipping', type)
+                file.seek(size - 4, 1)
             # that's it, no new informations should be in AVIX
             return False
         elif name == 'fmt ' and size <= 50:
@@ -556,11 +554,11 @@ class Riff(core.AVContainer):
         elif not name.strip(string.printable + string.whitespace):
             # check if name is something usefull at all, maybe it is no
             # avi or broken
-            t = file.seek(size,1)
-            log.debug("Skipping %s [%i]" % (name,size))
+            t = file.seek(size, 1)
+            log.debug(u'Skipping %r [%i]' % (name, size))
         else:
             # bad avi
-            log.debug("Bad or broken avi")
+            log.debug(u'Bad or broken avi')
             return False
         return True