Context Navigation

Changeset 3621

Timestamp:

12/10/08 22:26:54 (3 months ago)

Author:

dmeyer

Message:

add some doc strings

Location:

trunk/metadata/src

Files:

r3537	r3621
49	49
50	50	class AudioDisc(core.Disc):
	51	"""
	52	Audio CD support. It provides a list of tracks and if on Internet
	53	connection is available it will use CDDB for the metadata.
	54	"""
51	55	def __init__(self,device):
52	56	core.Disc.__init__(self)

r3613	r3621
110	110
111	111	class DVDInfo(core.Disc):
112
	112	"""
	113	DVD parser for DVD discs, DVD iso files and hard-disc and DVD
	114	directory structures with a VIDEO_TS folder.
	115	"""
113	116	_keys = core.Disc._keys + [ 'length' ]
114	117

r2943	r3621
72	72
73	73	class JPG(core.Image):
74
	74	"""
	75	JPEG parser supporting EXIf and IPTC tables. The important
	76	information is mapped to match the kaa.metadata key naming, the
	77	complete table can be accessed with the _tables variable.
	78	"""
75	79	table_mapping = { 'EXIF': EXIFMap, 'IPTC': IPTC.mapping }
76	80

r3613	r3621
116	116
117	117	class Asf(core.AVContainer):
	118	"""
	119	ASF video parser. The ASF format is also used for Microsft Windows
	120	Media files like wmv.
	121	"""
118	122	def __init__(self, file):
119	123	core.AVContainer.__init__(self)
…	…
376	380
377	381	class AsfAudio(audiocore.Audio):
	382	"""
	383	ASF audio parser for wma files.
	384	"""
378	385	def __init__(self):
379	386	audiocore.Audio.__init__(self)

r3613	r3621
78	78
79	79	class FlashVideo(core.AVContainer):
80
	80	"""
	81	Experimental parser for Flash videos. It requires certain flags to
	82	be set to report video resolutions and in most cases it does not
	83	provide that information.
	84	"""
81	85	table_mapping = { 'FLVINFO' : FLVINFO }
82	86

r3613	r3621
281	281	class Matroska(core.AVContainer):
282	282	"""
283		This is the main Matroska object
	283	Matroska video and audio parser. If at least one video stream is
	284	detected it will set the type to MEDIA_AV.
284	285	"""
285	286	media = core.MEDIA_AUDIO

r3258	r3621
170	170
171	171	class MPEG4(core.AVContainer):
172
	172	"""
	173	Parser for the MP4 container format. This format is mostly
	174	identical to Apple Quicktime and 3GP files. It maps to mp4, mov,
	175	qt and some other extensions.
	176	"""
173	177	table_mapping = { 'QTUDTA': QTUDTA }
174	178

r3613	r3621
137	137
138	138	class MPEG(core.AVContainer):
	139	"""
	140	Parser for various MPEG files. This includes MPEG-1 and MPEG-2
	141	program streams, elementary streams and transport streams. The
	142	reported length differs from the length reported by most video
	143	players but the provides length here is correct. An MPEG file has
	144	no additional metadata like title, etc; only codecs, length and
	145	resolution is reported back.
	146	"""
139	147	def __init__(self,file):
140	148	core.AVContainer.__init__(self)

r3536	r3621
78	78
79	79	class Riff(core.AVContainer):
80
	80	"""
	81	AVI parser also parsing metadata like title, languages, etc.
	82	"""
81	83	table_mapping = { 'AVIINFO' : AVIINFO }
82	84

r2581	r3621
39	39
40	40	class VCDFile(core.Collection):
	41	"""
	42	Parser for VCD files on hard-disc. It parses cue/bin file combinations.
	43	"""
41	44	def __init__(self, file):
42	45	core.Collection.__init__(self)