2 # This file is part of mp3togo
4 # Convert audio files to play on a mp3 player
5 # Manage program options
7 # (c) Simeon Veldstra 2004, 2006 <reallifesim@gmail.com>
9 # This software is free.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You may redistribute this program under the terms of the
17 # GNU General Public Licence version 2
18 # Available in this package or at http://www.fsf.org
20 # requires python-pyvorbis and python-id3 and lame
28 import mp3togo.options as options
30 from mp3togo.helpers import helpers
33 class Fail(options.Fail):
36 class Error(Exception):
39 class ErrorUnknownFileType(Error):
42 class ErrorNoFile(Error):
45 class ErrorNoCache(Error):
48 class ErrorBadFormat(Error):
51 class ErrorNoXMMSControl(Error):
54 class ErrorXMMSNotRunning(Error):
57 class ErrorNoDCOP(Error):
60 class ErrorAmarokNotRunning(Error):
63 class ErrorUnlocked(Error):
66 class TaskNotReadyError(Error):
69 class ErrorClusterProtocol(Error):
74 class Options(options.Options):
75 """Subclass options.Options and fill in application specific
77 def __init__(self, argv=None, conffile=None, readconf=True):
79 options.Options.__init__(self, absfile('~/.mp3togo'))
82 # ((name, short option, long option, default value, hook, help text), ...)
84 ('gui', 'X', 'gui-mode', False, None,
85 '''Start mp3togo GTK interface.'''),
86 ('brwarning', 't', 'file-tag', '.2go', None,
87 '''A string appended to the name of the file to indicate it has been recoded.'''),
88 ('tempdir', 'w', 'work-dir', '/tmp', self._absfile,
89 '''The path to store temporary files. This could need several hundred megabytes free.'''),
90 ('treedepth', 'd', 'tree-depth', 1, None,
91 '''The number of directory levels to preserve in the output tree. Use 0 to put all output files directly into the target directory. Use 2 to create a directory for the Artist and then the Album (Assuming your music collection is organized in directories by artist then album).'''),
92 ('treestructure', '', 'format', '', None,
93 '''A string specifying the format for the output files. The format string can contain the following escapes:<li>%a - Artist<li>%l - Album<li>%t - Title<li>%y - Year<li>%g - Genre<li>%% - Literal '%'<br>Overrides --tree-depth.'''),
94 ('notags', '', 'no-tags', False, None,
95 '''Do not try to write tags to the output files.'''),
96 ('maxunits', 'm', 'max-size', '0', self._units,
97 '''The disk space available to use in bytes. Append 'M' for megabytes, 'G' for gigabytes or 'K' for kilobytes. Use 0 to use all available space on the filesystem.'''),
98 ('maxsize', '', '', 0L, None, ''),
99 ('maxtempunits', '', 'max-temp-size', '0', self._units,
100 '''The disk space available to use for temporary files in bytes. Append 'M' for megabytes, 'G' for gigabytes or 'K' for kilobytes. Use 0 to use all available space on the filesystem.'''),
101 ('maxtempsize', '', '', 0L, None, ''),
102 ('force', 'F', 'force', False, None,
103 '''Overwrite files if they already exist.'''),
104 ('update', 'u', 'update', False, None,
105 '''Overwrite files if they already exist only if they are older than the source file.'''),
106 ('encoder', 'C', 'encoder', 'lame', None,
107 '''The encoder to use to create the output files. Options are wav, lame or oggenc.'''),
108 ('encopts', 'E', 'encoder-options', '', None,
109 '''Compression options for the encoder.'''),
110 ('compfactor', 'z', 'compression-factor', 18.0, None,
111 '''If you change the lame options, you must change this factor to match the compression rate of the new options. This is used to estimate completed file size.'''),
112 ('makecache', '', 'make-cache', '', self._absfile, '''Make an output file cache at the given path.'''),
113 ('cachesize', '', '', 0L, None, ''),
114 ('cacheunits', '', 'cache-size', '0', self._units, '''The size for the new cache.'''),
115 ('usecache', '', 'use-cache', '', self._absfile, '''Use the cache stored at the given path.'''),
116 ('help', 'h', 'help', False, None, '''Print this message.'''),
117 ('playlist', 'p', 'playlist', '', None,
118 '''The playlist to convert. Playlists can be simple lists of file paths, one per line, or .m3u files or the native XMMS playlist file format. Playlists can be also listed on the command line as free arguments after all of the options if they have a recognizable extension. Currently .m3u and .pls are recognized.'''),
119 ('readxmms', 'x', 'import-xmms', False, None,
120 '''Get playlist from running instance of XMMS. (You must have the python-xmms module installed)'''),
121 ('readamarok', '', 'import-amarok', False, None,
122 '''Get playlist from running instance of Amarok.'''),
123 ('playerdir', 'o', 'output-dir', os.curdir, self._absfile,
124 '''Where to write the output files.'''),
125 ('index', '', 'index', False, None,
126 '''Create an index file when in wav output mode.'''),
127 ('nonormal', '', 'no-normalize', False, None,
128 '''Don't normalize the wav file before encoding.'''),
129 ('cluster', '', 'cluster', '', None,
130 '''Manage a cluster of worker machines. Cluster mode distributes tracks between multiple computers connected to a LAN. Provide a comma separated list of IP addresses or hostnames. The master machine must be able to log in to the slaves without a password and the slaves must have shared access to the filesystem. See the website for an example of how to set it up.<li>http://puddle.ca/mp3togo/'''),
131 ('clusternolocal', '', 'cluster-no-local-node', False, None,
132 '''Only use the remote nodes for processing files.'''),
133 ('clusterslave', '', 'cluster-slave', False, None,
134 '''Start a worker process for cluster mode. This option is used by the cluster master to start slave processes. Do not use.''')]
136 # Override hook defined in Base class
137 self._conffile = self._absfile
139 # Options to not save to the config file:
140 self._nosave_options += []
142 # Binaries to check for:
143 self.bin['wav'] = True
144 self.bin['lame'] = False
145 self.bin['oggenc'] = False
146 self.bin['mpg321'] = False
147 self.bin['ogg123'] = False
148 self.bin['flac'] = False
149 self.bin['faad'] = False
150 self.bin['metaflac'] = False
151 self.bin['normalize-audio'] = False
152 self.bin['dcop'] = False
154 # What input types are supported on this system?
156 for helper in helpers.values():
157 if helper['action'] == 'decode':
158 bin = helper['cmd'].split()[0]
159 for path in map(lambda x: os.path.join(x, bin),
160 os.environ['PATH'].split(':')):
161 if os.path.exists(path):
162 if isinstance(helper['type'], (tuple, list)):
163 self.types.extend(helper['type'])
165 self.types.append(helper['type'])
168 self.version = mp3togo.version
169 self._help_preamble = """
171 mp3togo [-p playlist] [-o output-dir] [options] [input files]
174 mp3togo is a program for converting audio files of various
175 formats into a common format suitable for use on a portable
176 mp3 player or an mp3 CD. The files to convert can be
177 specified in a playlist file (m3u, pls and plain text are
178 supported) or given as arguments to the program. mp3togo
179 will go through the list and run mpg321, ogg123, flac, faad and
180 lame to decode and reencode the files. The newly encoded
181 files will be written to the destination directory. The
182 software can retain as much of the subdirectory structure
186 # Check for Third party modules:
187 self.mod['ogg.vorbis'] = False
188 self.mod['ID3'] = False
189 self.mod['eyeD3'] = False
190 self.mod['xmms'] = False
192 # Go ahead and read in the data:
193 self.getconf(argv, conffile, readconf)
197 # All hooks are called with the lock held
198 # and must reference the ._d dict directly
199 def _post_hook(self):
200 #Set up default encoder options if not specified:
201 if not self._d['encopts']:
202 self.reset_encoder_options()
204 def _absfile(self, name, value):
205 self._d[name] = absfile(value)
207 def _units(self, name, value):
208 #Calculate raw bytes and set [max|temp|cache]size
210 if value[-1] in ('b', 'B'):
212 if value[-1] in ('m', 'M'):
213 max = long(value[:-1]) * 1048576L
214 elif value[-1] in ('g', 'G'):
215 max = long(value[:-1]) * 1073741824L
216 elif value[-1] in ('k', 'K'):
217 max = long(value[:-1]) * 1024L
221 raise Fail, "Bad %s option: %s " % (name, value)
222 sizename = name.replace('units', 'size')
223 self._d[sizename] = max # 'maxsize'
224 self._d[name] = value # 'maxunits'
226 def _arg_files(self, name, value):
230 if os.path.exists(f):
234 def reset_encoder_options(self):
235 """Reset encoder options to defaults."""
236 if self._d['encoder'] == 'lame':
237 self._d['encopts'] = '--abr 96'
238 elif self._d['encoder'] == 'oggenc':
239 self._d['encopts'] = '-m 96 -M 225 -b 100'
240 elif self._d['encoder'] == 'wav':
241 self._d['encopts'] = ''
243 def cleanfilename(self, name):
244 """Remove nasty characters from a filename"""
245 name = name.replace('"', "'")
246 name = name.replace(':', '.')
247 name = name.replace("?", "")
248 name = name.replace('*', '')
249 name = name.replace('`', "'")
250 name = name.replace('&', '+')
251 name = name.replace(';', '.')
252 name = name.replace('#', '-')
253 name = name.replace('|', '-')
258 def getfiletype(self, filename):
259 """Return the format of an audio file"""
260 # Could use some more magic here
261 ft = os.path.splitext(filename)[1][1:]
262 #if ft not in ('mp3', 'ogg', 'flac', 'wav', 'm4a'):
263 if ft not in self.types:
264 raise ErrorUnknownFileType
267 def checkfile(self, name):
268 """Verify the existence of an audio file"""
269 name = name.replace('\n', '')
270 name = name.replace('\r', '')
271 name = name.replace('\f', '')
272 if not os.path.exists(name):
275 self.getfiletype(name) # Throws exception if unknown
278 def est_decoded_size(self, filename):
279 """Estimate size of decoded wav file."""
280 tp = self.getfiletype(filename)
281 helper = find_helper(tp, 'decode')
282 return os.stat(filename).st_size * helpers[helper]['factor']
288 """Try to print a message to a nonblocking stdout"""
289 for i in range(1, 6):
291 sys.stdout.write(msg)
294 time.sleep(0.01 ** (1.0 / i))
298 name = os.path.expanduser(name)
300 name = os.path.abspath(name)
303 def find_helper(type, action):
304 """Return the name of the best helper that performs 'action' on 'type'
306 Raises KeyError if type or action is unknown."""
307 for helper in helpers.keys():
308 if helpers[helper]['action'] == action and \
309 type in helpers[helper]['type']:
313 def make_args(helper, input, output, args=''):
314 """Substitute for command line args"""
315 esc = {'z': '%', 'i': "###input###", 'o': "###output###", 'a': args}
317 fmt = helpers[helper]['cmd']
318 fmt = fmt.replace('%%', '%z')
325 code = fmt[0] and fmt[0][0]
326 if code in esc.keys():
327 fmt[0] = esc[code] + fmt[0][1:]
331 # This foolishness is to prevent splitting
332 # filenames with whitespace in them.
333 if "###input###" in out:
334 out[out.index("###input###")] = input
335 if "###output###" in out:
336 out[out.index("###output###")] = output
projects / mp3togo / blob