Extend Musicbrainz multi-artist support
[abcde.git] / FAQ
diff --git a/FAQ b/FAQ
index 72f44bd..365f903 100644 (file)
--- a/FAQ
+++ b/FAQ
@@ -4,11 +4,10 @@
 Q. Who created abcde? Who develops it nowadays?
 A. It was originally created by Robert Woodcook. He decided to give up
    maintaining it at some point in 2002 and Jesus Climent took over. In 2012,
-   Colin Tuckley and Steve McIntyre joined in to help. Currently Steve maintains
-   abcde along with Andrew Strong. Contact either with comments or suggestions
-   at the following email addresses:
+   Colin Tuckley and Steve McIntyre joined in to help. During 2015-2016 Andrew
+   Strong helped out. Currently Steve maintains abcde. Contact Steve with
+   comments or suggestions at the following email address:
       Steve McIntyre <93sam@@debian.org>
-      Andrew Strong <andrew.david.strong@gmail.com>
 
 
 1. INSTALLATION
@@ -215,7 +214,7 @@ A. The details are contained in abcde within a new function called
    from within an ~/.abcde.conf file. The technique works in 3 possible
    ways:
 
-    1. If CDDBMETHOD is musicbrainz the album art is downloaded from
+    1. If CDDBMETHOD includes musicbrainz the album art is downloaded from
        coverartarchive by MBID (MusicBrainz Identifier)
     2. If 1 fails, download is tried from amazon by ASIN (Amazon 
        Standard Identification Number)
@@ -224,7 +223,7 @@ A. The details are contained in abcde within a new function called
 
    You  will need to install your distro's package of glyr, a music 
    related metadata search engine, and it is strongly advised that
-   you use 'musicbrainz' for your cddb lookups. To access the more 
+   you use 'musicbrainz' in your cddb lookups. To access the more 
    advanced features of getalbumart it is also strongly advised that
    you install the ImageMagick package of your distro. getalbumart 
    will work without ImageMagick but functionality will be reduced.
@@ -283,68 +282,30 @@ A. If you have set INTERACTIVE=y (this is the default) then you will have
    from online by typing in a URL or by typing in the path to a local file.
    
 Q. What if I want my album art embedded?
-A. The philosophy of getalbumart at the moment is to simply place the album
-   art in the same location as the encoded files. Perhaps this will change
-   one day. In the meantime you can use abcde's post_encode function in
-   your ~/.abcde.conf file to embed the album art. Here is an example for
-   mp3 embedding using eyeD3:
-
-   #----------------------------------------------------------------#
-   post_encode ()
-   {
-    ARTISTFILE="$(mungefilename "$TRACKARTIST")"
-    ALBUMFILE="$(mungefilename "$DALBUM")"
-
-   if [ "$VARIOUSARTISTS" = "y" ] ; then
-     FINDPATH="$(eval echo "$VAOUTPUTFORMAT")"
-   else
-     FINDPATH="$(eval echo "$OUTPUTFORMAT")"
-   fi
-
-   FINALDIR="$(dirname "$OUTPUTDIR/$FINDPATH")"
-   cd "$FINALDIR"
-
-   if [ "$OUTPUTTYPE" = "mp3" ] && [ "$TAGGER" = "$EYED3" ] ; then
-    vecho "Preparing to embed the album art..." >&2
-   else
-    vecho "Not embedding album art, you need mp3 output and eyeD3 tagging..." >&2
-    return 1
-   fi
-
-    if [ -e "cover.jpg" ] ; then
-      for i in *.mp3
-      do
-      eyeD3 --add-image cover.jpg:FRONT_COVER "$i"
-      done
-      mkdir backup && mv cover.jpg backup
-      vecho "Your files have had the album art embedded..." >&2
-    else
-     vecho "No album art found so no image embedded..." >&2
-    fi
-   }
-  #----------------------------------------------------------------#
-
-  Variations of the 'for' loop in this example should work for other encoding 
-  types. For example with flac:
-
-   #--------------------
-   for i in *.flac
-   do 
-    metaflac --import-picture-from=cover.jpg "$i"
-   done
-   #--------------------
-
-  With other appropriate adjustments to the $OUTPUTTYPE and $TAGGER checks of 
-  course...
-
+A. As of abcde 2.8.2 it is possible to have the album art automatically 
+   embedded in the mp3 container using eyeD3, embedded in the flac container
+   using metaflac, embedded in the m4a container using AtomicParsley,
+   embedded in the wv container using wvtag and embedded into an ogg
+   container using vorbiscomment.
+   
+   There are 3 different ways to accomplish this:
+   
+     1. Use the command line '-B' option (this will also call getalbumart)
+     2. Use the command line '-a embedalbumart' option to add to list of actions
+     3. Use 'embedalbumart' in the 'ACTIONS' list in ~/.abcde.conf
+     
+   Adding newer containers for album art embedding should be fairly straightforward
+   and these will be added when the right combination of available abcde developer
+   time and abcde user interest occurs...
   
 4. FORMATS
    =======
 
 Q. What formats can I encode my music to?
-A. As for version 2.2, abcde includes support for MP3, Ogg/Vorbis,
-   Ogg/Speex, Flac and MPP/MP+(Musepack). Support for AAC will be added once
-   an FLOSS encoder/decoder is working.
+A. As of version 2.8.2 abcde includes support for MP3, Ogg/Vorbis,
+   Ogg/Speex, Flac, MPP/MP+(Musepack), AAC, AIFF (Audio Interchange File Format),
+   Alac, WavPack, TTA (True Type Audio), APE (Monkey's Audio), Opus,
+   AC3 and MP2.
 
 Q. I want the new *put the newest and coolest codec there* format to be
    supported by abcde. Abcde is so cool but i want to encode also to this
@@ -459,7 +420,7 @@ A. The plan is to use FFmpeg (or avconv) when FFmpeg has a good quality native
    # Correct output type:
    OUTPUTTYPE="mp2"
    
-   So currently FFmpeg supports: alac, wavpack and mp2. FFmpeg native aac support will
+   Currently FFmpeg supports: alac, wavpack,mp2 and AIFF. FFmpeg native aac support will
    be added when it comes out of 'experimental'. FFmpeg is also used as the default
    encoder for the Matroska or mka container. A typical example, using the FFmpeg
    native ac3 encoder, is:
@@ -573,4 +534,3 @@ A. The default action set includes clean, which cleans the temp directory,
 
 --
 Steve McIntyre <93sam@@debian.org>
-Andrew Strong <andrew.david.strong@gmail.com>