← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/eyed3/oneiric

« back to all changes in this revision

Viewing changes to README.html

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Wirt
  • Date: 2006-11-18 01:47:38 UTC
  • mfrom: (1.2.1 upstream) (2.1.5 feisty)
  • Revision ID: james.westby@ubuntu.com-20061118014738-bcwcoe9gywrgorz2
New upstream version  

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.html
1
1
<HTML>
2
2
<HEAD>
3
3
<META NAME="generator" CONTENT="http://txt2tags.sf.net">
4
 
<TITLE>eyeD3 0.6.4</TITLE>
 
4
<TITLE>eyeD3 0.6.11</TITLE>
5
5
</HEAD><BODY BGCOLOR="white" TEXT="black">
6
 
<P ALIGN="center"><CENTER><H1>eyeD3 0.6.4</H1>
 
6
<P ALIGN="center"><CENTER><H1>eyeD3 0.6.11</H1>
7
7
<FONT SIZE=4>
8
8
<I>Travis Shirk &lt;<A HREF="mailto:travis@pobox.com">travis@pobox.com</A>&gt;</I><BR>
9
 
02.05.2005
 
9
11.05.2006
10
10
</FONT></CENTER>
11
11
 
12
12
<P>
18
18
<A HREF="http://id3lib.sourceforge.net/id3/id3v1.html">v1.0/v1.1</A>
19
19
and <A HREF="http://id3lib.sourceforge.net/id3/develop.html">v2.3/v2.4</A>.
20
20
<P>
21
 
The current stable version is 0.6.4.  It and earlier versions are
 
21
The current stable version is 0.6.11.  It and earlier versions are
22
22
available <A HREF="http://eyed3.nicfit.net/releases/">here</A>.
23
23
<P>
24
24
See the <A HREF="NEWS">NEWS</A> and/or <A HREF="ChangeLog">ChangeLog</A> for changes.
31
31
<P>
32
32
<H2>Source tarball</H2>
33
33
<PRE>
34
 
     gzip -dc eyeD3-0.6.4.tar.gz | tar xvf -
35
 
     cd eyeD3-0.6.4
 
34
     gzip -dc eyeD3-0.6.11.tar.gz | tar xvf -
 
35
     cd eyeD3-0.6.11
36
36
     ./configure
37
37
     make
38
38
     make install (as root)
45
45
See <A HREF="http://gentoo-portage.com/dev-python/eyeD3">here</A> for more info.
46
46
<H2>RPM</H2>
47
47
<PRE>
48
 
     rpm -Uvh ./eyeD3-0.6.4-1.noarch.rpm
 
48
     rpm -Uvh ./eyeD3-0.6.11-1.noarch.rpm
49
49
</PRE>
50
50
<H2>Debian</H2>
51
51
See <A HREF="http://packages.debian.org/eyed3">here</A> for more info.
52
52
<H2>Suse</H2>
53
53
See <A HREF="http://www.novell.com/products/linuxpackages/professional/python-eyed3.html">here</A> for more info.
 
54
<H2>Solaris SPARC and x86</H2>
 
55
Packages available from
 
56
<A HREF="http://www.blastwave.org/packages.php/pyeyed3">Blastwave</A>.
54
57
<P>
55
58
<H1>How to Use eyeD3</H1>
56
59
The 'eyeD3' utility program can perform most ID3 tasks, and it is also the
92
95
                          number.  See --list-genres
93
96
      -Y STRING, --year=STRING
94
97
                          Set a four digit year.
95
 
      --comment=[LANGUAGE]:[DESCRIPTION]:COMMENT
 
98
      -c [LANGUAGE]:[DESCRIPTION]:COMMENT, --comment=[LANGUAGE]:[DESCRIPTION]:COMMENT
96
99
                          Set comment
 
100
      -p STRING, --publisher=STRING
 
101
                          Set the publisher/label text
97
102
      --remove-comments   Remove all comment frames.
98
103
      --add-image=IMG_PATH:TYPE[:DESCRIPTION]
99
104
                          Add an image to the tag.  The description and type
100
105
                          optional, but when used, both ':' delimiters must be
101
106
                          present.  The type MUST be an string that corresponds to
102
 
                          one given with --list-image-types.
103
 
      -i, --write-images  Causes all attached images (APIC frames) to be written
104
 
                          to the current directory.
 
107
                          one given with --list-image-types. If the IMG_PATH value
 
108
                          is empty the APIC frame with TYPE is removed.
 
109
      -i DIR, --write-images=DIR
 
110
                          Causes all attached images (APIC frames) to be written
 
111
                          to the specified directory. If not directory specified
 
112
                          the images are written to .
105
113
      --set-text-frame=FID:TEXT
106
114
                          Set the value of a text frame.  To remove the frame,
107
115
                          specify an empty value.  e.g., --set-text-frame="TDRC:"
112
120
      --play-count=[+]N   If this argument value begins with '+' the tag's play
113
121
                          count (PCNT) is incremented by N, otherwise the value is
114
122
                          set to exactly N.
 
123
      --bpm=N             Set the beats per minute value.
115
124
      --unique-file-id=OWNER_ID:ID
116
125
                          Add a UFID frame.  If the ID arg is empty the UFID frame
117
126
                          with OWNER_ID is removed.  An OWNER_ID MUST be
131
140
                          data in the tag using substitution variables: %A
132
141
                          (artist), %a (album), %t (title), %n (track number), and
133
142
                          %N (total number of tracks)
 
143
      --fs-encoding=ENCODING
 
144
                          Use the specified character encoding for the filename
 
145
                          when renaming files
134
146
      -l, --list-genres   Display the table of ID3 genres and exit
135
147
      --list-image-types  List all possible image types
136
148
      --strict            Fail for tags that violate the ID3 specification.
148
160
<P>
149
161
Reading the contents of an mp3 file containing either v1 or v2 tag info:
150
162
<PRE>
151
 
     import eyeD3;
152
 
     tag = eyeD3.Tag();
153
 
     tag.link("/some/file.mp3");
154
 
     print tag.getArtist();
155
 
     print tag.getAlbum();
156
 
     print tag.getTitle();
 
163
     import eyeD3
 
164
     tag = eyeD3.Tag()
 
165
     tag.link("/some/file.mp3")
 
166
     print tag.getArtist()
 
167
     print tag.getAlbum()
 
168
     print tag.getTitle()
157
169
</PRE>
158
170
<P>
159
171
Read an mp3 file (track length, bitrate, etc.) and access it's tag:
160
172
<PRE>
161
173
  if eyeD3.isMp3File(f):
162
 
     audioFile = eyeD3.Mp3AudioFile(f, self.opts.tagVersion);
163
 
     tag = audioFile.getTag();
 
174
     audioFile = eyeD3.Mp3AudioFile(f, self.opts.tagVersion)
 
175
     tag = audioFile.getTag()
164
176
</PRE>
165
177
<P>
166
178
Specific tag versions can be selected:
167
179
<PRE>
168
 
     tag.link("/some/file.mp3", eyeD3.ID3_V2);
169
 
     tag.link("/some/file.mp3", eyeD3.ID3_V1);
170
 
     tag.link("/some/file.mp3", eyeD3.ID3_ANY);  # The default.
 
180
     tag.link("/some/file.mp3", eyeD3.ID3_V2)
 
181
     tag.link("/some/file.mp3", eyeD3.ID3_V1)
 
182
     tag.link("/some/file.mp3", eyeD3.ID3_ANY_VERSION)  # The default.
171
183
</PRE>
172
184
<P>
173
185
Or you can iterate over the raw frames:
174
186
<PRE>
175
 
     tag = eyeD3.Tag();
176
 
     tag.link("/some/file.mp3");
 
187
     tag = eyeD3.Tag()
 
188
     tag.link("/some/file.mp3")
177
189
     for frame in tag.frames:
178
 
        print frame;
 
190
        print frame
179
191
</PRE>
180
192
<P>
181
193
Once a tag is linked to a file it can be modified and saved:
182
194
<PRE>
183
 
     tag.setArtist(u"Cro-Mags");
184
 
     tag.setAlbulm(u"Age of Quarrel");
185
 
     tag.update();
 
195
     tag.setArtist(u"Cro-Mags")
 
196
     tag.setAlbulm(u"Age of Quarrel")
 
197
     tag.update()
186
198
</PRE>
187
199
<P>
188
200
If the tag linked in was v2 and you'd like to save it as v1:
189
201
<PRE>
190
 
     tag.update(eyeD3.ID3_V1_1);
 
202
     tag.update(eyeD3.ID3_V1_1)
191
203
</PRE>
192
204
<P>
193
205
Read in a tag and remove it from the file:
194
206
<PRE>
195
 
     tag.link("/some/file.mp3");
196
 
     tag.remove();
 
207
     tag.link("/some/file.mp3")
 
208
     tag.remove()
197
209
</PRE>
198
210
<P>
199
211
<H1>Support</H1>
202
214
<P>
203
215
<H1>Bugs and Patches</H1>
204
216
Find bugs! Please submit all comments, bug reports, or feature requests
205
 
to Travis Shirk &lt;<A HREF="mailto:travis@pobox.com">travis@pobox.com</A>&gt;. Those of of the patch variety are
 
217
to Travis Shirk &lt;<A HREF="mailto:travis@pobox.com">travis@pobox.com</A>&gt;. Those of the patch variety are
206
218
especially welcome :)
207
219
<P>
208
220
<H1>See Also</H1>