mime types
[software/python-on-guile.git] / modules / language / python / module / email / mime / audio.py
1 module(email,mime,audio)
2
3 # Copyright (C) 2001-2007 Python Software Foundation
4 # Author: Anthony Baxter
5 # Contact: email-sig@python.org
6
7 """Class representing audio/* type MIME documents."""
8
9 __all__ = ['MIMEAudio']
10
11 import sndhdr
12
13 from io import BytesIO
14 import email.encoders as encoders
15 from email.mime.nonmultipart import MIMENonMultipart
16
17
18
19 _sndhdr_MIMEmap = {'au' : 'basic',
20 'wav' :'x-wav',
21 'aiff':'x-aiff',
22 'aifc':'x-aiff',
23 }
24
25 # There are others in sndhdr that don't have MIME types. :(
26 # Additional ones to be added to sndhdr? midi, mp3, realaudio, wma??
27 def _whatsnd(data):
28 """Try to identify a sound file type.
29
30 sndhdr.what() has a pretty cruddy interface, unfortunately. This is why
31 we re-do it here. It would be easier to reverse engineer the Unix 'file'
32 command and use the standard 'magic' file, as shipped with a modern Unix.
33 """
34 hdr = data[:512]
35 fakefile = BytesIO(hdr)
36 for testfn in sndhdr.tests:
37 res = testfn(hdr, fakefile)
38 if res is not None:
39 return _sndhdr_MIMEmap.get(res[0])
40 return None
41
42
43
44 class MIMEAudio(MIMENonMultipart):
45 """Class for generating audio/* MIME documents."""
46
47 def __init__(self, _audiodata, _subtype=None,
48 _encoder=encoders.encode_base64, *, policy=None, **_params):
49 """Create an audio/* type MIME document.
50
51 _audiodata is a string containing the raw audio data. If this data
52 can be decoded by the standard Python `sndhdr' module, then the
53 subtype will be automatically included in the Content-Type header.
54 Otherwise, you can specify the specific audio subtype via the
55 _subtype parameter. If _subtype is not given, and no subtype can be
56 guessed, a TypeError is raised.
57
58 _encoder is a function which will perform the actual encoding for
59 transport of the image data. It takes one argument, which is this
60 Image instance. It should use get_payload() and set_payload() to
61 change the payload to the encoded form. It should also add any
62 Content-Transfer-Encoding or other headers to the message as
63 necessary. The default encoding is Base64.
64
65 Any additional keyword arguments are passed to the base class
66 constructor, which turns them into parameters on the Content-Type
67 header.
68 """
69 if _subtype is None:
70 _subtype = _whatsnd(_audiodata)
71 if _subtype is None:
72 raise TypeError('Could not find audio MIME subtype')
73 MIMENonMultipart.__init__(self, 'audio', _subtype, policy=policy,
74 **_params)
75 self.set_payload(_audiodata)
76 _encoder(self)