1## This is the README file for dekagen Sun Jan 11 19:07:26 CET 2004 2## =========================================================================== 3 4dekagen is a front-end to several tools for the ripping, converting, and 5naming of MP3 and Ogg-Vorbis files. It automates the whole process of ripping 6data from music compact discs (CD), the naming of the files, their converting 7into MP3 or Ogg-Vorbis format and the labelling of the MP3 files with an ID3 8tag. dekagen uses dialog for a user interface that is intended to be 9"intuitive". 10 11Music data is read from CDs using cdda2wav, cdparanoia, dagrab, or tosha, and 12stored on your harddisk in wav-format. Note that this will have an excessive 13need of disk space. After this, the wav-data is converted into MP3 format 14using 8hz-mp3, bladeenc, l3enc, lame, mp3enc, or notlame, or into Ogg-Vorbis 15format using oggenc. This will take a while. To avoid manual naming and 16tagging for all the files, cda is used for CDDB lookups. To label the MP3 17files with ID3 tags, id3ed, id3tag, id3tool, or mp3info, or the built-in 18capabilities of some encoders (lame, notlame) are used. Ogg-Vorbis files can 19be labelled with oggenc. 20 21 22# ---------------------------------------------------------------------------- 23# Be sure you have already installed on your system: 24 251. cdda2wav, cdparanoia, dagrab, or tosha, 262. 8hz-mp3, bladeenc, l3enc, lame, mp3enc, or notlame, 27 or oggenc. 28You might also wish to install: 293. xmcd, 304. id3ed, id3tag, id3tool, or mp3info. 31 32� cdda2wav is available under GNU GPL at 33 http://www.escape.de/users/colossus/cdda2wav.html 34� cdparanoia is available under GNU GPL at http://www.xiph.org/paranoia/ 35� dagrab is available in two flavours, both under GNU GPL, at 36 http://web.tiscali.it/marcellou/dagrab.html or 37 http://vertigo.fme.vutbr.cz/~stibor/dagrab.html 38� bladeenc is available under GNU LGPL at http://bladeenc.mp3.no/ 39� lame is available under GNU LGPL at http://www.mp3dev.org/ 40� notlame is available under GNU LGPL at 41 http://www.idiap.ch/~sanders/not_lame/ 42� oggenc is available under GNU GPL at http://www.vorbis.com/download_unix.psp 43� xmcd is available under GNU GPL at http://www.amb.org/xmcd/ 44� id3ed is available under GNU GPL at 45 http://www.azstarnet.com/~donut/programs/id3ed.html 46� id3tag is available under GNU LGPL at http://id3lib.sourceforge.net/ 47� id3tool is available under GNU GPL at http://kitsumi.xware.cx/id3tool/ 48� mp3info is available under GNU GPL at http://www.ibiblio.org/mp3info/ 49 50You will find oggenc included in the "vorbis-tools" package, cda in the "xmcd" 51package, and id3tag in the "id3lib" (or "id3lib-examples" on RPM-based 52systems) package. 53Please note that some rippers have to be run suid root. 54ID3 tagging utilities are not needed when using lame or notlame, because 55these programs have a built-in ID3 tagging, and cannot be used together with 56oggenc, because Ogg-Vorbis has its own tagging system. 57 58dekagen was developed and tested under Linux with the programs mentioned 59above, but it should work on other UNIX-like platforms as well (in particular 60on FreeBSD), provided that all required programs (at least a bourne-compatible 61shell, "dialog", a ripper, and an encoder) are available. 62 63dekagen has been tested with dialog v.0.6, available under GNU GPL at 64http://www.ibiblio.org/pub/Linux/utils/shell/. It should work, however, also 65with "cdialog", or dialog v.0.9. 66 67 68# ---------------------------------------------------------------------------- 69# Published under the terms of the GNU General Public License. 70 71This program is free software; you can redistribute it and/or modify it under 72the terms of the GNU General Public License as published by the Free Software 73Foundation; either version 2 of the License, or (at your option) any later 74version. 75 76This program is distributed in the hope that it will be useful, but WITHOUT 77ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 78FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 79details. 80 81You should have received a copy of the GNU General Public License along with 82this program; if not, write to the Free Software Foundation, Inc., 59 Temple 83Place - Suite 330, Boston, MA 02111-1307, USA. 84 85 86# ---------------------------------------------------------------------------- 87# Download locations: 88 89The latest version of dekagen can be found at: 90 91 http://userpage.fu-berlin.de/~mbayer/tools/dekagen.html 92or 93 [ftp|http]://ftp.ibiblio.org/pub/linux/apps/sound/convert/ 94 95If you are going to retrieve the source code from within automated scripts, 96e.g. by a software packaging manager, please prefer downloading it from the 97Ibiblio server or one of its mirrors. 98 99 100# ---------------------------------------------------------------------------- 101# Be aware of legal restrictions: 102 103In some countries, the use of MP3-generating algorithms may be subject to 104licence restrictions. Please check the documentation of your encoding tool 105or consider the use of Ogg-Vorbis instead of MP3. 106 107 108# ---------------------------------------------------------------------------- 109# Be aware of the following changes in Version 0.8: 110 111When aborting the program with <CTRL>+C, or <ESC>, or selecting the 'Cancel' 112item in the main dialogue, background encoding activities will be terminated. 113Only if the program is left with the 'quit' menu item, the user will be asked 114whether he wishes to abort background encoding processes or not. In the latter 115case the background encodings and ID3 labellings will proceed normally. 116 117 118# ---------------------------------------------------------------------------- 119# The name changed with version 0.9: 120 121dekagen was formerly published under the name "ripenc". This tool was 122maintained up to version 0.7 by Michael J. Parmeley. Since in 2000 it seemed 123as if he had given up its development, I re-published it after considerable 124changes under the version number 0.8.X. After he had re-appeared on the net, 125he refused to apply the changes of my 0.8-releases to his program core. But 126then he published an other release of "ripenc", based on version 0.7, that 127included a lot of the code-cleaning I made, except for the "dialog"-based user 128interface. Since as a consequence two different programs with the same name, 129but different interfaces existed, I decided to rename the ripenc-series with 130the "dialog"-interface (versions 0.8.X) to "dekagen" (version 0.9 and newer). 131 132 133# ---------------------------------------------------------------------------- 134# New auto-configuring features in version 1.0: 135 136If you run dekagen for the first time, it will look for the third-party 137software it requires automatically, setting its preferences accordingly. 138After this, dekagen will check these settings on every run, and adjust them 139automatically if needed. 140 141This search will proceed according to a built-in order. If you are an 142administrator and going to install dekagen system-wide, you can pre-set 143the defaults in the lines 36-49 of the script. dekagen will then look for 144these programs first. Otherwise there is no need to change these values. 145 146 147# ---------------------------------------------------------------------------- 148# Prospects for the next version: 149 150� Drop support for 8hz-mp3, l3enc, mp3enc, and tosha? 151 152� Bladeenc is not being developed any more. If we droped support for it, too, 153 we could do without any external ID3 tool, using the built-in tagging 154 capabilities of lame, notlame, and oggenc. 155 156� Quality level settings (for lame, notlame, and oggenc) as an alternative to 157 (nominal) bitrate settings? 158 159� Use dagrab for retrieving CDDB data as an alternative to xmcd (cda)? 160 161� Add support for lossless compression algorithms, like MPEG-4 ALS 162 (http://www.nue.tu-berlin.de/forschung/projekte/lossless/mpeg4als.html), 163 formerly known as LPAC, and/or FLAC (http://flac.sourceforge.net/)? 164 165� Make pre-set defaults (lines 36-49) a system-wide configuration file, e.g. 166 /etc/dekagenrc? 167 168Suggestions and comments are welcome. 169 170 171# ---------------------------------------------------------------------------- 172# �We accept patches.� 173 174Please include in all your messages information on 175 � the version of dekagen you are referring to (`dekagen --version`), 176 � name and version of your operating system (`uname -a`), 177 � name and version of your shell (e.g. `bash --version`) and 178 other third-party-software (like cda) related to your problem. 179 180If you think you found a possible security impact, please let _me_ know 181_first_. 182 183If you think you found a bug, please try to describe it as exactly as 184possible, in order to save other people's time. I will not consider any "bug 185report" that just claims "your program is buggy!!!!!1", nor will I answer to 186any mail asking me OS-specific questions. 187 188I will include into the TODO list any sensible feature request. 189 190And, last but not least, patches are always very welcome. :-) 191 192 193Martin Bayer <mbayer@zedat.fu-berlin.de> 194 195 For all e-mails, use of PGP (GPG) is encouraged. You will find my 196 public key (ID: 0xCB537B60) on my homepage and on keyservers. The key's 197 fingerprint is: "46A1 B556 41CD C77A 0261 D22F 41A6 EB90 CB53 7B60". 198