commit current WIP packaging to VCS
[alioth/soundfonts.git] / debian / fix-ICOP.py
1 #!/usr/bin/python3
2 # coding: UTF-8
3 #-
4 # Copyright © 2018 Thorsten Glaser <tg@mirbsd.de>
5 #
6 # Permission is hereby granted, free of charge, to any person
7 # obtaining a copy of this software and associated documentation
8 # files (the "Software"), to deal in the Software without
9 # restriction, including without limitation the rights to use,
10 # copy, modify, merge, publish, distribute, sublicense, and/or sell
11 # copies of the Software, and to permit persons to whom the
12 # Software is furnished to do so, subject to the following
13 # conditions:
14 #
15 # The above copyright notice and this permission notice shall be
16 # included in all copies or substantial portions of the Software.
17 #
18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20 # OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 # OTHER DEALINGS IN THE SOFTWARE.
26 #-
27 # python3 fix-ICOP.py -d src.sf2  # dump info only
28 # python3 fix-ICOP.py src.sf2 dst.sf2 'name' 'new (c)' 'engineer' 'comment'
29 # The comment field is limited to 65535 ASCII bytes, the others to 255.
30 #
31 # You may also use this under the terms of The MirOS Licence instead.
32
33 from io import SEEK_SET, SEEK_CUR
34 import struct
35 import sys
36
37 assert(sys.version_info[0] >= 3)
38
39 class RIFFChunk(object):
40     def __init__(self, parent):
41         self.parent = parent
42         self.file = parent
43         while isinstance(self.file, RIFFChunk):
44             self.file = self.file.parent
45
46         cn = self.file.read(4)
47         cs = self.file.read(4)
48         ct = None
49         cf = cn
50         if (len(cn) != 4) or (len(cs) != 4):
51             raise EOFError
52         co = self.file.tell()
53         try:
54             cs = struct.unpack_from('<L', cs)[0]
55         except struct.error:
56             raise EOFError
57         if cn in (b'RIFF', b'LIST'):
58             ct = self.file.read(4)
59             if len(ct) != 4:
60                 raise EOFError
61             cf = cn + b'<' + ct + b'>'
62
63         self.chunkname = cn
64         self.chunksize = cs
65         self.chunk_pad = cs & 1
66         self.container = ct
67         self.children = []
68         self.chunkfmt = cf
69         self.data_ofs = co
70         self.data_mem = None
71         self.justpast = self.data_ofs + self.chunksize + self.chunk_pad
72
73         if isinstance(self.parent, RIFFChunk) and \
74           self.justpast > self.parent.justpast:
75             raise IndexError('End of this %s chunk %d > end of parent %s chunk %d' % \
76               (self.chunkfmt, self.justpast, self.parent.chunkfmt, self.parent.justpast))
77
78         if self.container is not None:
79             while True:
80                 try:
81                     child = RIFFChunk(self)
82                 except EOFError:
83                     break
84                 self.children.append(child)
85                 if child.skip_past():
86                     break
87
88     def __str__(self):
89         s = '<RIFFChunk(%s)' % self.chunkfmt
90         if self.container is not None:
91             q = '['
92             for child in self.children:
93                 s += q + str(child)
94                 q = ', '
95             s += ']'
96         return s + '>'
97
98     def skip_past(self):
99         self.file.seek(self.justpast, SEEK_SET)
100         return isinstance(self.parent, RIFFChunk) and \
101           self.justpast == self.parent.justpast
102
103     def __getitem__(self, key):
104         if self.container is None:
105             raise IndexError('Chunk %s is not of a container type' % self.chunkname)
106         for child in self.children:
107             if child.chunkfmt == key:
108                 return child
109         raise IndexError('Chunk %s does not have a child %s' % (self.chunkname, key))
110
111     def print(self):
112         if self.container is not None:
113             raise IndexError('Chunk %s is of a container type' % self.chunkname)
114         if self.data_mem is not None:
115             return self.data_mem
116         self.file.seek(self.data_ofs, SEEK_SET)
117         s = self.file.read(self.chunksize)
118         if len(s) != self.chunksize:
119             raise IOError('Could not read %d data bytes (got %d)' % (self.chunksize, len(s)))
120         return s
121
122     def write(self, file):
123         if not isinstance(self.chunkname, bytes):
124             raise ValueError('Chunk name %s is not of type bytes' % self.chunkname)
125         if len(self.chunkname) != 4:
126             raise ValueError('Chunk name %s is not of length 4')
127         if file.write(self.chunkname + struct.pack('<L', self.chunksize)) != 8:
128             raise IOError('Could not write header bytes to destination file at chunk %s' % \
129               self.chunkfmt)
130         if self.container is not None:
131             cld = file.tell()
132             if not isinstance(self.container, bytes):
133                 raise ValueError('Container type %s is not of type bytes' % self.container)
134             if len(self.container) != 4:
135                 raise ValueError('Container type %s is not of length 4')
136             if file.write(self.container) != 4:
137                 raise IOError('Could not write container bytes to destination file at chunk %s' % \
138                   self.chunkfmt)
139             for child in self.children:
140                 child.write(file)
141             cld = file.tell() - cld
142             if cld != self.chunksize:
143                 raise ValueError('Children wrote %d bytes (expected %d) file at chunk %s' % \
144                   (cld, self.chunksize, self.chunkfmt))
145         else:
146             if self.data_mem is not None:
147                 if file.write(self.data_mem) != self.chunksize:
148                     raise IOError('Could not write %d data bytes to destination file at chunk %s' % \
149                       (self.chunksize, self.chunkfmt))
150             else:
151                 self.file.seek(self.data_ofs, SEEK_SET)
152                 total = self.chunksize
153                 while total > 0:
154                     n = 65536
155                     if n > total:
156                         n = total
157                     buf = self.file.read(n)
158                     n = len(buf)
159                     total -= n
160                     if file.write(buf) != n:
161                         raise IOError('Could not write %d data bytes to destination file at chunk %s' % \
162                           (n, self.chunkfmt))
163         if self.chunk_pad > 0:
164             file.write(b'\0')
165         if file.tell() & 1:
166             raise ValueError('Misaligned file after chunk %s' % self.chunkfmt)
167
168     def set_length(self, newlen):
169         old = self.chunksize + self.chunk_pad
170         self.chunksize = newlen
171         self.chunk_pad = self.chunksize & 1
172         new = self.chunksize + self.chunk_pad
173         if isinstance(self.parent, RIFFChunk):
174             self.parent.adjust_length(new - old)
175
176     def set_content(self, content, nul_pad=False):
177         if self.container is not None:
178             raise ValueError('Cannot set content of container type %s' % self.chunkfmt)
179         if isinstance(content, str):
180             content = content.encode('UTF-8')
181         if not isinstance(content, bytes):
182             raise ValueError('New content is not of type bytes')
183         if nul_pad and (len(content) & 1):
184             content += b'\0'
185         self.data_mem = content
186         self.set_length(len(content))
187
188     def adjust_length(self, delta):
189         self.set_length(self.chunksize + delta)
190
191 class RIFFFile(RIFFChunk):
192     def __init__(self, file):
193         self.file = file
194         self.container = True
195         self.children = []
196
197         child = None
198         while True:
199             try:
200                 child = RIFFChunk(f)
201             except EOFError:
202                 break
203             self.children.append(child)
204
205         if child is None:
206             raise IndexError('No RIFF chunks found')
207
208         self.justpast = child.justpast
209
210     def __str__(self):
211         s = '<RIFFFile'
212         q = '['
213         for child in self.children:
214             s += q + str(child)
215             q = ', '
216         return s + ']>'
217
218     def __getitem__(self, key):
219         return self.children[key]
220
221     def write(self, file):
222         for child in self.children:
223             child.write(file)
224
225 def dumpriff(container, level=0, isinfo=False):
226     indent = ('%s%ds' % ('%', 2*level)) % ''
227     print(indent + 'BEGIN level=%d' % level)
228     for chunk in container.children:
229         #print(indent + ' CHUNK %s of size %d, data at %d, next at %d' % (chunk.chunkfmt, chunk.chunksize, chunk.data_ofs, chunk.justpast))
230         if isinfo:
231             print(indent + ' CHUNK %s(%d): %s' % (chunk.chunkfmt, chunk.chunksize, chunk.print()))
232         else:
233             print(indent + ' CHUNK %s of size %d' % (chunk.chunkfmt, chunk.chunksize))
234         if chunk.container is not None:
235             dumpriff(chunk, level+1, chunk.chunkfmt == b'LIST<INFO>')
236     print(indent + 'END level=%d' % level)
237
238 print('START')
239 if sys.argv[1] == '-d':
240     with open(sys.argv[2], 'rb') as f:
241         riff = RIFFFile(f)
242         dumpriff(riff)
243 else:
244     with open(sys.argv[1], 'rb') as f, open(sys.argv[2], 'wb', buffering=65536) as dst:
245         riff = RIFFFile(f)
246         dumpriff(riff)
247         riff[0][b'LIST<INFO>'][b'INAM'].set_content(sys.argv[3] + '\0', True)
248         riff[0][b'LIST<INFO>'][b'ICOP'].set_content(sys.argv[4] + '\0', True)
249         riff[0][b'LIST<INFO>'][b'IENG'].set_content(sys.argv[5] + '\0', True)
250         riff[0][b'LIST<INFO>'][b'ICMT'].set_content(sys.argv[6] + '\0', True)
251         riff.write(dst)
252 print('OUT')