bionic (1) fadecut.1.gz

Provided by: fadecut_0.2.1-1_all bug

DESCRIPTION

       fadecut  is  a  script  to  rip  audio files from a livestream (using stream- ripper) and to process them
       automatically.  Beginning and ending fo the audio files will be cut  and  faded  in/out.   So  logos  and
       advertising of radio stations will be automatically removed.

       In  streaming  mode  fadecut  is  ripping audio files using streamripper.  The downloaded audio files are
       cutted using silence detection and then faded in and out.  Subsequently, the files are encoded to  either
       ogg or mp3 and tagged with tags (title, artist, genre and comment provided).

       In file mode fadecut is just processing already ripped audio files.

       An  audio file which has already been processed is detected and will not be processed again.  Not desired
       songs can be stored in a separate directory.  This files are not processed anymore too.

FOLDERS

       fadecut is working with some standard folders.  You may change them in your profile or fadecutrc

       done/ here you put all your songs which were already processed by fadecut and which  you  want  to  keep.
       See also new/ folder.

       dontlike/  in this folder you may put songs which you don't like.  Fadecut is checking this folder before
       it is processing new files in the working folder.  Null size files are ok.

       error/ whenever an error occurs while fadecut is processing a file, that  file  is  moved  to  the  error
       folder for later examining.

       incomplete/ this folder is created by streamripper.  All not fully ripped songs are saved here.

       new/  processed songs are going here.  Usually you may rip and process files with fadecut, they are going
       in to new/ folder, you listen to them and put good songs to the done/ folder.

       orig/ if you want to keep the original file (which is ripped  by  stream-ripper),  you  may  use  the  -k
       option.  fadecut is putting the ripped files untouched into that folder.

OPTIONS

       -c Create a new profile

       -e Edit an existing profile

       -l list all existing profiles

       -i optional input

       -o optional output

       -k optional to keep the untouched original song in the /orig folder

       -d Debug: -d 0|1|2|3 (level 0 is standard, -d without number is like 1)

       -h Show this message

       -p Profile

       -q Quiet

       -r Stream (and rip), start streamripper

       -t add Timestamp to the Filename

       -v Verbose

VARIABLES

       URL to stream

              STREAM_URL="http://streamurl"

       Preferred destination fileformat.  (opus/ogg/mp3)

              ENCODING=ogg

       Processed files will get the above genre.

              GENRE="SwissPop"

       Processed files will get the above comment.

              COMMENT="Radio Swiss Pop"

       Cut seconds off the file in the beginning.

              TRIM_BEGIN=0

       Cut seconds off the file at the end.

              TRIM_END=0

       Fade in for seconds.

              FADE_IN=1

       Fade out for seconds.

              FADE_OUT=4

       Set the user-agent used by streamripper

              USER_AGENT="Streamripper/1.x"

EXAMPLES

       Create a new ripping profile

              fadecut -c test

       Edit/update profile test

              fadecut -e test

       Rip, cut and fade in-/out with profile test

              fadecut -p test -r

       Only cut and fade in-/out without ripping from livestream

              fadecut -p test

SEE ALSO

       id3v2(1), oggenc(1), opusenc(1), sox(1), streamripper(1), lame(1)

FILES

       ~/.fadecut/fadecutrc is the main fadecut configuration file, executed with every start of fadecut.

       Content of fadecutrc # which files to work on FILES=*.mp3

              # target format [ogg/mp3]
              ENCODING=mp3

              # --- Defaults for the profiles ---

              # trim n seconds at beginning
              TRIM_BEGIN=0

              # trim n seconds at end of song
              TRIM_END=0

              # seconds to fade in
              FADE_IN=0

              # seconds to fade out
              FADE_OUT=0

              # --- Directories ---

              # main directory of fadecut
              PWD=$(pwd)

              # where to write logfiles
              LOGDIR=/tmp

              # profiledir
              PROFILEDIR="$HOME/.fadecut"

              # workdir
              WORKDIR="$PWD"

              # where to put fadecut'ted files
              OUTPUTDIR="$PWD/new"

              # where to put original files
              ORIGDIR="$PWD/orig"

              # here the user puts finished files, which are
              # tested and listened
              DONEDIR="$PWD/done"

              # here are songs we don't like
              DONTLIKEDIR="$PWD/dontlike"

              # files had an error
              ERRORDIR="$PWD/error"

              # here to put temporary files
              TMPDIR=/tmp

              # --- Other options ---
              # enqueue to rhythmbox or vlc
              ENQUEUE=0

              # keep or don't keep original files
              KEEPORIG=1

              # debug level 0-3
              DEBUG=0

              # verbosity level
              VERBOSE=1

              # loop interval in seconds
              LOOP_INTERVAL=10

              # restart interval streamripper
              RESTART_STREAMRIPPER_INTERVAL=900

              # start streamripper [0/1]
              STREAMRIPPER_START=0

              # streamripper useragent
              USER_AGENT="Streamripper/1.x"

              # streamripper options
              STREAMRIPPER_OPTS="-o always -T"

       ~/.fadecut/statslog.csv is the statistics file.

              Contains a table of processed files

              Format:
              Date dd.mm.yyyy;Time hh:mm:ss;Artist;Songtitle;Genre;profile;fadecut-task;filename

              Example:
              09.05.2014;10:14:54;Androcell;Hindu Kush;Lounge;alounge;processing;androcell_-_hindu_kush.ogg

       ~/.fadecut/profiles is the folder where all profiles are located.

       To create a profile file

                  fadecut -c myradiostation

       Settings in the profile file

                  # url to the radio stream:
                  STREAM_URL="http://streamurl"

              # mp3-genre which will be written to the downloaded mp3-files
                  GENRE="Pop"

              # comment which will be written to the downloaded mp3-files
                  COMMENT="Radio station comment"

              # how many seconds to fade in the song
                  FADE_IN=1

              # how many seconds to fade out the song
                  FADE_OUT=4

              # how many seconds to cut from the beginning of the song
              TRIM_BEGIN=0

              # how many seconds to cut at the end of the song
              TRIM_END=0

RESOURCES

       fadecut git website: https://github.com/fadecut/fadecut

AUTHORS

       Martin Gafner, Marco Balmer.

                                                   March 2013                                         fadecut(1)