← Back to branch summary

~ubuntu-branches/ubuntu/trusty/eyed3/trusty

« back to all changes in this revision

Viewing changes to README.html

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Wirt
  • Date: 2008-06-10 14:19:01 UTC
  • mfrom: (2.1.9 hardy)
  • Revision ID: james.westby@ubuntu.com-20080610141901-88htgr85j3t2bev4
Tags: 0.6.16
http://bugs.debian.org/474656
* New upstream release
  - Lines of 80 dashes should be 79 (Closes: #474656)

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.11</TITLE>
 
4
<TITLE>eyeD3 0.6.16</TITLE>
5
5
</HEAD><BODY BGCOLOR="white" TEXT="black">
6
 
<P ALIGN="center"><CENTER><H1>eyeD3 0.6.11</H1>
 
6
<P ALIGN="center"><CENTER><H1>eyeD3 0.6.16</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
 
11.05.2006
 
9
06.08.2008
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.11.  It and earlier versions are
 
21
The current stable version is 0.6.16.  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.11.tar.gz | tar xvf -
35
 
     cd eyeD3-0.6.11
 
34
     gzip -dc eyeD3-0.6.16.tar.gz | tar xvf -
 
35
     cd eyeD3-0.6.16
36
36
     ./configure
37
37
     make
38
38
     make install (as root)
43
43
     emerge eyeD3
44
44
</PRE>
45
45
See <A HREF="http://gentoo-portage.com/dev-python/eyeD3">here</A> for more info.
46
 
<H2>RPM</H2>
47
 
<PRE>
48
 
     rpm -Uvh ./eyeD3-0.6.11-1.noarch.rpm
49
 
</PRE>
 
46
<P>
 
47
<H2>Ubuntu</H2>
 
48
See <A HREF="http://packages.ubuntu.com/search?keywords=eyeD3&searchon=names&suite=all&section=all">here</A> for more info.
 
49
<P>
50
50
<H2>Debian</H2>
51
51
See <A HREF="http://packages.debian.org/eyed3">here</A> for more info.
 
52
<P>
52
53
<H2>Suse</H2>
53
54
See <A HREF="http://www.novell.com/products/linuxpackages/professional/python-eyed3.html">here</A> for more info.
 
55
<P>
 
56
<H2>Slackware</H2>
 
57
See <A HREF="http://www.linuxpackages.net/search_view.php?by=name&name=eyeD3&ver=">linuxpackages.net</A> for more info.
 
58
<P>
54
59
<H2>Solaris SPARC and x86</H2>
55
60
Packages available from
56
61
<A HREF="http://www.blastwave.org/packages.php/pyeyed3">Blastwave</A>.
59
64
The 'eyeD3' utility program can perform most ID3 tasks, and it is also the
60
65
best example of how to use the API.  It supports the following features:
61
66
<PRE>
 
67
  
62
68
  Usage
63
69
  =====
64
70
    eyeD3 [OPTS] file [file...]
65
71
  
66
 
  options
 
72
  Options
67
73
  =======
68
74
    --version             show program's version number and exit
69
75
    -h, --help            show this help message and exit
70
76
  
71
77
  Tag Versions
72
78
  ------------
73
 
      -1, --v1            Only read/write ID3 v1.x tags. By default, v1.x tags are
74
 
                          only read if there is not a v2.x tag.
 
79
      -1, --v1            Only read/write ID3 v1.x tags. By default, v1.x tags
 
80
                          are only read if there is not a v2.x tag.
75
81
      -2, --v2            Only read/write ID3 v2.x tags.
76
82
      --to-v1.1           Convert the file's tag to ID3 v1.1. (Or 1.0 if there is
77
83
                          no track number.)
97
103
                          Set a four digit year.
98
104
      -c [LANGUAGE]:[DESCRIPTION]:COMMENT, --comment=[LANGUAGE]:[DESCRIPTION]:COMMENT
99
105
                          Set comment
 
106
      -L [LANGUAGE]:[DESCRIPTION]:LYRICS, --lyrics=[LANGUAGE]:[DESCRIPTION]:LYRICS
 
107
                          Set lyrics
100
108
      -p STRING, --publisher=STRING
101
109
                          Set the publisher/label text
102
110
      --remove-comments   Remove all comment frames.
 
111
      --remove-lyrics     Remove all lyrics frames.
103
112
      --add-image=IMG_PATH:TYPE[:DESCRIPTION]
104
113
                          Add an image to the tag.  The description and type
105
114
                          optional, but when used, both ':' delimiters must be
106
 
                          present.  The type MUST be an string that corresponds to
107
 
                          one given with --list-image-types. If the IMG_PATH value
108
 
                          is empty the APIC frame with TYPE is removed.
 
115
                          present.  The type MUST be an string that corresponds
 
116
                          to one given with --list-image-types. If the IMG_PATH
 
117
                          value is empty the APIC frame with TYPE is removed.
 
118
      --remove-images     Remove all image (APIC) frames.
 
119
      --add-object=OBJ_PATH[:DESCRIPTION[:MIME-TYPE[:FILENAME]]
 
120
                          Add an encapsulated object to the tag.  The description
 
121
                          and filename are optional, but when used, the ':'
 
122
                          delimiters must be present.  If the OBJ_PATH value is
 
123
                          empty the GEOB frame with DESCRIPTION is removed.
109
124
      -i DIR, --write-images=DIR
110
125
                          Causes all attached images (APIC frames) to be written
111
 
                          to the specified directory. If not directory specified
112
 
                          the images are written to .
 
126
                          to the specified directory.
 
127
      -o DIR, --write-objects=DIR
 
128
                          Causes all attached objects (GEOB frames) to be written
 
129
                          to the specified directory.
113
130
      --set-text-frame=FID:TEXT
114
131
                          Set the value of a text frame.  To remove the frame,
115
132
                          specify an empty value.  e.g., --set-text-frame="TDRC:"
118
135
                          remove the frame, specify an empty value.  e.g., --set-
119
136
                          user-text-frame="SomeDesc:"
120
137
      --play-count=[+]N   If this argument value begins with '+' the tag's play
121
 
                          count (PCNT) is incremented by N, otherwise the value is
122
 
                          set to exactly N.
 
138
                          count (PCNT) is incremented by N, otherwise the value
 
139
                          is set to exactly N.
123
140
      --bpm=N             Set the beats per minute value.
124
141
      --unique-file-id=OWNER_ID:ID
125
 
                          Add a UFID frame.  If the ID arg is empty the UFID frame
126
 
                          with OWNER_ID is removed.  An OWNER_ID MUST be
 
142
                          Add a UFID frame.  If the ID arg is empty the UFID
 
143
                          frame with OWNER_ID is removed.  An OWNER_ID MUST be
127
144
                          specified.
128
145
      --set-encoding=latin1|utf8|utf16-BE|utf16-LE
129
146
                          Set the encoding that is used for _all_ text frames.
138
155
  -------------
139
156
      --rename=NAME       Rename file (the extension is not affected) based on
140
157
                          data in the tag using substitution variables: %A
141
 
                          (artist), %a (album), %t (title), %n (track number), and
142
 
                          %N (total number of tracks)
 
158
                          (artist), %a (album), %t (title), %n (track number),
 
159
                          and %N (total number of tracks)
143
160
      --fs-encoding=ENCODING
144
161
                          Use the specified character encoding for the filename
145
162
                          when renaming files
146
163
      -l, --list-genres   Display the table of ID3 genres and exit
147
164
      --list-image-types  List all possible image types
148
165
      --strict            Fail for tags that violate the ID3 specification.
149
 
      --jep-118           Output the tag per the format described in JEP-0118. See
150
 
                          http://www.jabber.org/jeps/jep-0118.html
 
166
      --jep-118           Output the tag per the format described in JEP-0118.
 
167
                          See http://www.xmpp.org/extensions/xep-0118.html
 
168
      --nfo               Output NFO information.
 
169
      --lametag           Prints the LAME Tag.
151
170
      --force-update      Update the tag regardless of whether any frames are set
152
171
                          with new values.
153
172
      --no-color          Disable color output
 
173
      --no-zero-padding   Don't pad track or disc numbers with 0's
 
174
      --no-tagging-time-frame
 
175
                          When saving tags do not add a TDTG (tagging time) frame
 
176
      -F DELIM            Specify a new delimiter for option values that contain
 
177
                          multiple fields (default delimiter is ':')
154
178
      -v, --verbose       Show all available information
155
179
      --debug             Trace program execution.
 
180
      --run-profiler      Run using python profiler.
156
181
</PRE>
157
182
<P>
158
183
Some simple programming examples follow here, excluding any error handling,
171
196
Read an mp3 file (track length, bitrate, etc.) and access it's tag:
172
197
<PRE>
173
198
  if eyeD3.isMp3File(f):
174
 
     audioFile = eyeD3.Mp3AudioFile(f, self.opts.tagVersion)
 
199
     audioFile = eyeD3.Mp3AudioFile(f)
175
200
     tag = audioFile.getTag()
176
201
</PRE>
177
202
<P>
193
218
Once a tag is linked to a file it can be modified and saved:
194
219
<PRE>
195
220
     tag.setArtist(u"Cro-Mags")
196
 
     tag.setAlbulm(u"Age of Quarrel")
 
221
     tag.setAlbum(u"Age of Quarrel")
197
222
     tag.update()
198
223
</PRE>
199
224
<P>
206
231
<PRE>
207
232
     tag.link("/some/file.mp3")
208
233
     tag.remove()
 
234
     tag.update()
 
235
</PRE>
 
236
<P>
 
237
Add a new tag:
 
238
<PRE>
 
239
     tag = eyeD3.Tag()
 
240
     tag.link('/some/file.mp3')    # no tag in this file, link returned False
 
241
     tag.header.setVersion(eyeD3.ID3_V2_3)
 
242
     tag.setArtist('Fugazi')
 
243
     tag.update()
209
244
</PRE>
210
245
<P>
211
246
<H1>Support</H1>