diff options
Diffstat (limited to 'audio/fIcy')
| -rw-r--r-- | audio/fIcy/README | 17 | ||||
| -rw-r--r-- | audio/fIcy/fIcy.1 | 443 | ||||
| -rw-r--r-- | audio/fIcy/fIcy.SlackBuild | 78 | ||||
| -rw-r--r-- | audio/fIcy/fIcy.info | 10 | ||||
| -rw-r--r-- | audio/fIcy/fIcy.pod | 315 | ||||
| -rw-r--r-- | audio/fIcy/slack-desc | 19 |
6 files changed, 882 insertions, 0 deletions
diff --git a/audio/fIcy/README b/audio/fIcy/README new file mode 100644 index 0000000000..62d29cc8e6 --- /dev/null +++ b/audio/fIcy/README @@ -0,0 +1,17 @@ +fIcy (icecast/shoutcast stream grabber suite) + +fIcy is a small icecast/shoutcast stream grabber suite for use under +shell environment. Its goal is to automatically rip a stream into +user customisable files. It will work with ICY compatible streams, +allowing you to either to save the stream to disk or to pipe the output +to a media player, or even both. fIcy, among other uses, is ideal for +batch/unattended recording of radio programs and stream debugging. + +The fIcy package includes: + +- fIcy itself, a stream separator/multiplexer, +- fResync, a fast MPEG-resyncing utility, +- fPls, a playlist frontend for fIcy. + +Note: the name "fIcy" has a capital i in it, not a lowercase L. Hard to +tell in some fonts. diff --git a/audio/fIcy/fIcy.1 b/audio/fIcy/fIcy.1 new file mode 100644 index 0000000000..2251f2d684 --- /dev/null +++ b/audio/fIcy/fIcy.1 @@ -0,0 +1,443 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "FICY 1" +.TH FICY 1 "2013-05-12" "1.0.18" "SlackBuilds.org" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +fIcy \- an icecast/shoutcast stream grabber suite +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +fIcy \fB[options]\fR \fBserver [port [path]]|url\fR +.PP +The main program. Takes directly a stream url and dumps the tracks on +the specified file/s and standard output, depending on the settings. +.PP +fPls \fB[options]\fR \fBfile|url\fR \fB[fIcy options]\fR +.PP +Playlist manager. Reads a playlist (local or remote) and manages fIcy +retries/timeouts/errors, forwarding the specified flags. +.PP +fResync \fB[options]\fR \fBfile\fR +.PP +\&\s-1MPEG\s0 resyncing utility. Re-aligns head frame headers on dumped or +broken files. Usually needed for embedded hardware decoders or editing +software. +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +fIcy is a small icecast/shoutcast stream grabber suite for use under shell +environment. Its goal is to automatically rip a stream into user customisable +files. It will work with \s-1ICY\s0 compatible streams, allowing you to either to save +the stream to disk or to pipe the output to a media player, or even both. fIcy, +among other uses, is ideal for batch/unattended recording of radio programs and +stream debugging. +.PP +The fIcy package includes: +.IP "\-" 4 +fIcy itself, a stream separator/multiplexer, +.IP "\-" 4 +fResync, a fast MPEG-resyncing utility, +.IP "\-" 4 +fPls, a playlist frontend for fIcy. +.SH "OPTIONS" +.IX Header "OPTIONS" +.SS "fIcy options" +.IX Subsection "fIcy options" +.Vb 2 +\& \-d Do not dump the output to stdout. +\& Useful when only ripping. +\& +\& \-E num Enumerate files when song title [metadata] changes, starting at +\& num. When 0, fIcy will try to find the highest unused file +\& number automatically. Uses \-o as a prefix. +\& +\& \-h Help +\& +\& \-c Do not clobber files. +\& +\& \-m Use song title [metadata] when naming files. Uses \-o as prefix. +\& +\& \-n If the file exists create new one with .n as suffix. +\& +\& \-p When dumping to stdout consider writing errors as transient +\& (that is: flush the output buffer until stdout is ready). +\& Useful when you pipe the output to a media player and want to +\& kill it while not interrupting the rip. +\& +\& \-o file Dump the output to file or use file as a prefix (depending on +\& other settings). Hint: to dump without a prefix use "./". +\& +\& \-s suffix Use sfx as a suffix for new files. +\& Hint: the .mp3/.m4a extension is NOT implicit. +\& +\& \-t Display song title [metadata] while ripping. +\& +\& \-r Remove/don\*(Aqt save partial chunks. This will skip the first +\& chunk and remove the last one upon termination which are +\& (supposedly) incomplete. To use in combination with \-m or \-E. +\& +\& \-q file Append "file name" sequence to file. The file name is written +\& upon file completition. This may be used to trigger events and +\& rejoin splitted parts with an external tool without \-E. +\& fResync will use this file in the future. +\& +\& \-x regex Save only files whose title (NOT filename) matches against this +\& (or one of these) extended regular expressions. Multiple \-x can +\& be specified on the command line to form OR conditions. Dump +\& unaffected. Can be combined with \-X. +\& +\& \-X regex Do NOT save files whose title matches against this extended +\& regular expression. Same semantics as \-x. +\& +\& \-I file Load include/exclude REs from file. Each line must be prefixed +\& with + or \- to indicate whether it\*(Aqs a positive or negative +\& expression (\-xX). +\& +\& \-f expr Filter titles through the specified coprocessor expression. The +\& raw title is passed to the expression (doesn\*(Aqt include any +\& additional prefixes/suffixes). As the result will be used +\& internally, some limitations apply. Read carefully the +\& Filtering_ section. +\& +\& \-F file Filter titles through the specified coprocessor script. Same +\& semantics as \-f, but the expressions are loaded from a file +\& instead. Conflicts with \-f. +\& +\& \-C path Specify the path of the external title rewriting coprocessor. +\& Defaults to "sed". The executable must support the \*(Aq\-e\*(Aq, \*(Aq\-f\*(Aq +\& flags and operate through stdin/out, like "sed". +\& +\& \-M time Maximum recording time. See Notes_. +\& +\& \-i time Maximum network idle time. Stops recording after the specified +\& amount of time is passed without network activity. Defaults to +\& 0 (default tcp timeout). +\& +\& \-a file Read authentication credentials from file (the file must +\& contain a line of the form user:password). Note that only the +\& Basic HTTP authentication scheme is supported. +\& +\& \-l num Redirect follow limit. Defaults to 1. 0 disables redirection +\& entirely. +.Ve +.SS "fResync options" +.IX Subsection "fResync options" +.Vb 4 +\& \-b By default fResync maps the entire file into memory when +\& operating. However this can create problems on loaded systems +\& with large files or when simulating. This reverts to a +\& buffered I/O mode. This flag is also implicit when simulating. +\& +\& \-s Simulate the process. Print on the standard output the starting +\& sync offset and stream length, but don\*(Aqt modify the source +\& file. +\& +\& \-v Verbose. +\& +\& \-n frames Require/decode at least n valid consecutive frames to validate +\& the sync offset. Defaults to 6. +\& +\& \-m len Maximum frame length. Defaults to 1597. fResync uses this value +\& to determine the maximal region of the file to be checked. +.Ve +.SS "fPls options" +.IX Subsection "fPls options" +.Vb 2 +\& \-P path Specify a different name or full path for the fIcy executable +\& (defaults to "fIcy"). +\& +\& \-v Verbose. +\& +\& \-R max Specifies the maximal number of retries to do for each stream +\& upon connection/read failure. +\& +\& \-L max Specifies the maximal number of loops to do for the entire +\& playlist (\-1 for infinite). +\& +\& \-T time Wait time to pause after each failure. +\& +\& \-M time Maximum cumulative recording time. See Notes_. +\& +\& \-i time Maximum network idle time. Same as fIcy\*(Aqs when loading a +\& playlist via http. Forwarded to fIcy. +\& +\& \-a file Read authentication credentials from file. Same as fIcy\*(Aqs when +\& loading a playlist via http. The credentials are automatically +\& forwarded to fIcy, but you can override them when needed. +\& +\& \-l num Redirect follow limit. Same as fIcy\*(Aqs when loading a playlist +\& via http. Forwarded to fIcy. +\& +\& \-d file Run as a daemon, redirecting messages to file. fIcy\*(Aqs \-d +\& option is enforced. As the process is chdir\-ed to the root +\& directory you also have to specify absolute paths for all +\& options, including fIcy\*(Aqs ones. +.Ve +.SH "EXAMPLES" +.IX Header "EXAMPLES" +Use fIcy to display \s-1ICY\s0 titles while playing:: +.PP +.Vb 1 +\& fPls http://example.com:8080/listen.pls \-t | mpg123 \- +.Ve +.PP +Rip a station until stopped:: +.PP +.Vb 1 +\& fPls \-L\-1 http://netradio.invalid/listen.pls \-s.mp3 \-o./ \-cmrd +.Ve +.PP +Connect directly to the stream with server:port and /path:: +.PP +.Vb 1 +\& fIcy \-s .mp3 \-o ./ \-md 123.123.123.123 8080 /path/to/stream +.Ve +.PP +Rip an .mp3 stream while playing, but allows the player to be restarted later +by using a named fifo (note that you can re/open \*(L"fifo\*(R" with any player):: +.PP +.Vb 3 +\& $ mkfifo fifo +\& $ fIcy \-p ... > fifo +\& $ mpg123 fifo +.Ve +.PP +Record your favourite program \*(L"\s-1XYZ\s0\*(R" usually on-air between 16:30\-17:00:: +.PP +.Vb 3 +\& at 16:30 +\& fPls \-M 30m http://example.com/listen.pls \-o program.mp3 \-x XYZ +\& ^D +.Ve +.PP +Cleanup a ripped and/or damaged mp3 file:: +.PP +.Vb 1 +\& fResync file.mp3 +.Ve +.SH "NOTES" +.IX Header "NOTES" +The output files produced by fIcy may miss audio framing information and +headers since the separation does not consider the audio data. For this reason, +your player 'may' (but should not) fail to reproduce the dump or output some +initial noise: this is expected. fResync can be used to cleanup \s-1MPEG\s0 files +after processing. +.PP +You can also use other tools such as mpgedit for cutting the file in arbitrary +positions without diminishing the quality. Assuming that your song spans across +three files (use \-q to know which ones), that's how to proceed:: +.PP +.Vb 1 +\& cat 1.mp3 2.mp3 3.mp3 > temp.mp3 && xmpgedit temp.mp3 +.Ve +.PP +Do *not* resync the files if you're going to post-process them this way: +fResync would remove at least one boundary frame on each file, while other +tools could also insert extra empty frames to silence the decoder! +.PP +The \-M flag supported by both fIcy and fPls accepts a time specification in +seconds, `HH:MM` or `N minutes/hours/days`. Time starts just after the +connection has been established, but without counting further delays. Also +beware that \-M specified in fPls means `cumulative recording time` (time +accumulates across retries/timeouts), while \-M specified in fIcy means `single +stream recording time` (recording stops at the first error or when the +specified time has elapsed). +.SH "FILTERING" +.IX Header "FILTERING" +Most online radio stations tend to put banners in the title that will be shown +in the player, and eventually result in the filename. To overcome to this (and +more), fIcy offers the possibility to rewrite each title through a normal sed +script via the \*(L"\-fF\*(R" flags. A real sed coprocess is used along the execution so +all of sed's power is available, but some limitations apply: +.PP +* Each line of input should result in one output line, and \s-1ONE\s0 \s-1ONLY\s0. +.PP +* Two consecutive identical titles will result in the second one + being ignored (thus \s-1NOT\s0 splitting the stream). Consider this rule, + as removing carefully the banner could result in a better separation. +.PP +* The resulting title will still apply for \-xXI as usual. +.PP +* Please note that the *title* is filtered, not the filename (which may + still have some characters removed/modified). Use \-tv to see what is + actually sent to the filter. +.PP +You can actually use any executable that works as a stream editor by specifying +the path with '\-C'. The executable must support the '\-e' (inline expression) +and '\-f' (script file) flags or, at least, ignore them. This allows for any +script or custom executable to be used when a \*(L"sed\*(R" script is considered +inadequate. +.SS "Filtering examples" +.IX Subsection "Filtering examples" +As an example, suppose your titles look like this:: +.PP +.Vb 1 +\& Artist \- Title (radiobanner) +.Ve +.PP +You can write a sed expression or script containing:: +.PP +.Vb 1 +\& s/ (radiobanner)$// +.Ve +.PP +to remove the trailing part. This facility can also be used to uniform file +names, invert Artist/Title positions and so on. Clever use of the pattern space +can also be used to merge albums. sed alone can be used to debug expressions, +eg:: +.PP +.Vb 1 +\& echo "test title" | sed \-e \*(Aqexpr\*(Aq +.Ve +.PP +Refer to the \fIsed\fR\|(1) manual for a complete list of commands you can use. +.SH "DISCLAIMER" +.IX Header "DISCLAIMER" +We would like to remind you that saving streams containing copyrighted material +without explicit consent is *ILLEGAL*. For stream administrators, please see +our statement in the \s-1FAQ\s0. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +bfr <http://www.glines.org/software/bfr> +.PP +.Vb 1 +\& Audio\-oriented rebuffering tool. Ideal for lousy streams. +.Ve +.PP +mpgedit <http://www.mpgedit.org/> +.PP +.Vb 1 +\& Frame\-level mp3 cutting tool. +.Ve +.SH "AUTHORS" +.IX Header "AUTHORS" +fIcy was written by Yuri D'Elia (\fIwavexx@users.sf.net\fR) and +David Leonardi (\fIdavid@mediavitamin.com\fR) +.PP +This manual page by B. Watson for the SlackBuilds.org project. It may +be used by anyone. diff --git a/audio/fIcy/fIcy.SlackBuild b/audio/fIcy/fIcy.SlackBuild new file mode 100644 index 0000000000..ed0dff3f19 --- /dev/null +++ b/audio/fIcy/fIcy.SlackBuild @@ -0,0 +1,78 @@ +#!/bin/bash + +# Slackware build script for fIcy + +# Written by B. Watson (yalhcru@gmail.com) + +# Licensed under the WTFPL. See http://www.wtfpl.net/txt/copying/ for details. + +PRGNAM=fIcy +VERSION=${VERSION:-1.0.18} +BUILD=${BUILD:-1} +TAG=${TAG:-_SBo} + +if [ -z "$ARCH" ]; then + case "$( uname -m )" in + i?86) ARCH=i486 ;; + arm*) ARCH=arm ;; + *) ARCH=$( uname -m ) ;; + esac +fi + +CWD=$(pwd) +TMP=${TMP:-/tmp/SBo} +PKG=$TMP/package-$PRGNAM +OUTPUT=${OUTPUT:-/tmp} + +if [ "$ARCH" = "i486" ]; then + SLKCFLAGS="-O2 -march=i486 -mtune=i686" + LIBDIRSUFFIX="" +elif [ "$ARCH" = "i686" ]; then + SLKCFLAGS="-O2 -march=i686 -mtune=i686" + LIBDIRSUFFIX="" +elif [ "$ARCH" = "x86_64" ]; then + SLKCFLAGS="-O2 -fPIC" + LIBDIRSUFFIX="64" +else + SLKCFLAGS="-O2" + LIBDIRSUFFIX="" +fi + +set -e + +rm -rf $PKG +mkdir -p $TMP $PKG $OUTPUT +cd $TMP +rm -rf $PRGNAM-$VERSION +tar xvf $CWD/$PRGNAM-$VERSION.tar.gz +cd $PRGNAM-$VERSION +chown -R root:root . +find . \ + \( -perm 777 -o -perm 775 -o -perm 711 -o -perm 555 -o -perm 511 \) \ + -exec chmod 755 {} \; -o \ + \( -perm 666 -o -perm 664 -o -perm 600 -o -perm 444 -o -perm 440 -o -perm 400 \) \ + -exec chmod 644 {} \; + +make CXXFLAGS="$SLKCFLAGS" + +# no 'make install' target, do it manually. +mkdir -p $PKG/usr/man/man1 $PKG/usr/bin + +install -s -m0755 $PRGNAM $PKG/usr/bin +install -s -m0755 fResync $PKG/usr/bin +install -s -m0755 fPls $PKG/usr/bin + +# Man page made for this SlackBuild, from README contents. +gzip -9c < $CWD/$PRGNAM.1 > $PKG/usr/man/man1/$PRGNAM.1.gz +ln -s $PRGNAM.1.gz $PKG/usr/man/man1/fResync.1.gz +ln -s $PRGNAM.1.gz $PKG/usr/man/man1/fPls.1.gz + +mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION +cp -a AUTHORS COPYING FAQ NEWS TODO $PKG/usr/doc/$PRGNAM-$VERSION +cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild + +mkdir -p $PKG/install +cat $CWD/slack-desc > $PKG/install/slack-desc + +cd $PKG +/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.${PKGTYPE:-tgz} diff --git a/audio/fIcy/fIcy.info b/audio/fIcy/fIcy.info new file mode 100644 index 0000000000..0bfb6849ea --- /dev/null +++ b/audio/fIcy/fIcy.info @@ -0,0 +1,10 @@ +PRGNAM="fIcy" +VERSION="1.0.18" +HOMEPAGE="http://www.thregr.org/~wavexx/software/fIcy/" +DOWNLOAD="http://www.thregr.org/~wavexx/software/fIcy/releases/fIcy-1.0.18.tar.gz" +DOWNLOAD_x86_64="" +MD5SUM="72a48db0116be57c2c3342d1efd5c893" +MD5SUM_x86_64="" +REQUIRES="" +MAINTAINER="B. Watson" +EMAIL="yalhcru@gmail.com" diff --git a/audio/fIcy/fIcy.pod b/audio/fIcy/fIcy.pod new file mode 100644 index 0000000000..969d2e221b --- /dev/null +++ b/audio/fIcy/fIcy.pod @@ -0,0 +1,315 @@ +# pod source for fIcy/fResync/fPls man page. Build with: +# pod2man -s1 -r1.0.18 --stderr -nFICY -c'SlackBuilds.org' + +=pod + +=head1 NAME + +fIcy - an icecast/shoutcast stream grabber suite + +=head1 SYNOPSIS + +fIcy B<[options]> B<server [port [path]]|url> + +The main program. Takes directly a stream url and dumps the tracks on +the specified file/s and standard output, depending on the settings. + +fPls B<[options]> B<file|url> B<[fIcy options]> + +Playlist manager. Reads a playlist (local or remote) and manages fIcy +retries/timeouts/errors, forwarding the specified flags. + +fResync B<[options]> B<file> + +MPEG resyncing utility. Re-aligns head frame headers on dumped or +broken files. Usually needed for embedded hardware decoders or editing +software. + +=head1 DESCRIPTION + +fIcy is a small icecast/shoutcast stream grabber suite for use under shell +environment. Its goal is to automatically rip a stream into user customisable +files. It will work with ICY compatible streams, allowing you to either to save +the stream to disk or to pipe the output to a media player, or even both. fIcy, +among other uses, is ideal for batch/unattended recording of radio programs and +stream debugging. + +The fIcy package includes: + +=over + +=item - + +fIcy itself, a stream separator/multiplexer, + +=item - + +fResync, a fast MPEG-resyncing utility, + +=item - + +fPls, a playlist frontend for fIcy. + +=back + +=head1 OPTIONS + +=head2 fIcy options + + -d Do not dump the output to stdout. + Useful when only ripping. + + -E num Enumerate files when song title [metadata] changes, starting at + num. When 0, fIcy will try to find the highest unused file + number automatically. Uses -o as a prefix. + + -h Help + + -c Do not clobber files. + + -m Use song title [metadata] when naming files. Uses -o as prefix. + + -n If the file exists create new one with .n as suffix. + + -p When dumping to stdout consider writing errors as transient + (that is: flush the output buffer until stdout is ready). + Useful when you pipe the output to a media player and want to + kill it while not interrupting the rip. + + -o file Dump the output to file or use file as a prefix (depending on + other settings). Hint: to dump without a prefix use "./". + + -s suffix Use sfx as a suffix for new files. + Hint: the .mp3/.m4a extension is NOT implicit. + + -t Display song title [metadata] while ripping. + + -r Remove/don't save partial chunks. This will skip the first + chunk and remove the last one upon termination which are + (supposedly) incomplete. To use in combination with -m or -E. + + -q file Append "file name" sequence to file. The file name is written + upon file completition. This may be used to trigger events and + rejoin splitted parts with an external tool without -E. + fResync will use this file in the future. + + -x regex Save only files whose title (NOT filename) matches against this + (or one of these) extended regular expressions. Multiple -x can + be specified on the command line to form OR conditions. Dump + unaffected. Can be combined with -X. + + -X regex Do NOT save files whose title matches against this extended + regular expression. Same semantics as -x. + + -I file Load include/exclude REs from file. Each line must be prefixed + with + or - to indicate whether it's a positive or negative + expression (-xX). + + -f expr Filter titles through the specified coprocessor expression. The + raw title is passed to the expression (doesn't include any + additional prefixes/suffixes). As the result will be used + internally, some limitations apply. Read carefully the + Filtering_ section. + + -F file Filter titles through the specified coprocessor script. Same + semantics as -f, but the expressions are loaded from a file + instead. Conflicts with -f. + + -C path Specify the path of the external title rewriting coprocessor. + Defaults to "sed". The executable must support the '-e', '-f' + flags and operate through stdin/out, like "sed". + + -M time Maximum recording time. See Notes_. + + -i time Maximum network idle time. Stops recording after the specified + amount of time is passed without network activity. Defaults to + 0 (default tcp timeout). + + -a file Read authentication credentials from file (the file must + contain a line of the form user:password). Note that only the + Basic HTTP authentication scheme is supported. + + -l num Redirect follow limit. Defaults to 1. 0 disables redirection + entirely. + + +=head2 fResync options + + -b By default fResync maps the entire file into memory when + operating. However this can create problems on loaded systems + with large files or when simulating. This reverts to a + buffered I/O mode. This flag is also implicit when simulating. + + -s Simulate the process. Print on the standard output the starting + sync offset and stream length, but don't modify the source + file. + + -v Verbose. + + -n frames Require/decode at least n valid consecutive frames to validate + the sync offset. Defaults to 6. + + -m len Maximum frame length. Defaults to 1597. fResync uses this value + to determine the maximal region of the file to be checked. + + +=head2 fPls options + + -P path Specify a different name or full path for the fIcy executable + (defaults to "fIcy"). + + -v Verbose. + + -R max Specifies the maximal number of retries to do for each stream + upon connection/read failure. + + -L max Specifies the maximal number of loops to do for the entire + playlist (-1 for infinite). + + -T time Wait time to pause after each failure. + + -M time Maximum cumulative recording time. See Notes_. + + -i time Maximum network idle time. Same as fIcy's when loading a + playlist via http. Forwarded to fIcy. + + -a file Read authentication credentials from file. Same as fIcy's when + loading a playlist via http. The credentials are automatically + forwarded to fIcy, but you can override them when needed. + + -l num Redirect follow limit. Same as fIcy's when loading a playlist + via http. Forwarded to fIcy. + + -d file Run as a daemon, redirecting messages to file. fIcy's -d + option is enforced. As the process is chdir-ed to the root + directory you also have to specify absolute paths for all + options, including fIcy's ones. + + +=head1 EXAMPLES + +Use fIcy to display ICY titles while playing:: + + fPls http://example.com:8080/listen.pls -t | mpg123 - + +Rip a station until stopped:: + + fPls -L-1 http://netradio.invalid/listen.pls -s.mp3 -o./ -cmrd + +Connect directly to the stream with server:port and /path:: + + fIcy -s .mp3 -o ./ -md 123.123.123.123 8080 /path/to/stream + +Rip an .mp3 stream while playing, but allows the player to be restarted later +by using a named fifo (note that you can re/open "fifo" with any player):: + + $ mkfifo fifo + $ fIcy -p ... > fifo + $ mpg123 fifo + +Record your favourite program "XYZ" usually on-air between 16:30-17:00:: + + at 16:30 + fPls -M 30m http://example.com/listen.pls -o program.mp3 -x XYZ + ^D + +Cleanup a ripped and/or damaged mp3 file:: + + fResync file.mp3 + + +=head1 NOTES + +The output files produced by fIcy may miss audio framing information and +headers since the separation does not consider the audio data. For this reason, +your player 'may' (but should not) fail to reproduce the dump or output some +initial noise: this is expected. fResync can be used to cleanup MPEG files +after processing. + +You can also use other tools such as mpgedit for cutting the file in arbitrary +positions without diminishing the quality. Assuming that your song spans across +three files (use -q to know which ones), that's how to proceed:: + + cat 1.mp3 2.mp3 3.mp3 > temp.mp3 && xmpgedit temp.mp3 + +Do *not* resync the files if you're going to post-process them this way: +fResync would remove at least one boundary frame on each file, while other +tools could also insert extra empty frames to silence the decoder! + +The -M flag supported by both fIcy and fPls accepts a time specification in +seconds, `HH:MM` or `N minutes/hours/days`. Time starts just after the +connection has been established, but without counting further delays. Also +beware that -M specified in fPls means `cumulative recording time` (time +accumulates across retries/timeouts), while -M specified in fIcy means `single +stream recording time` (recording stops at the first error or when the +specified time has elapsed). + +=head1 FILTERING + +Most online radio stations tend to put banners in the title that will be shown +in the player, and eventually result in the filename. To overcome to this (and +more), fIcy offers the possibility to rewrite each title through a normal sed +script via the "-fF" flags. A real sed coprocess is used along the execution so +all of sed's power is available, but some limitations apply: + +* Each line of input should result in one output line, and ONE ONLY. + +* Two consecutive identical titles will result in the second one + being ignored (thus NOT splitting the stream). Consider this rule, + as removing carefully the banner could result in a better separation. + +* The resulting title will still apply for -xXI as usual. + +* Please note that the *title* is filtered, not the filename (which may + still have some characters removed/modified). Use -tv to see what is + actually sent to the filter. + +You can actually use any executable that works as a stream editor by specifying +the path with '-C'. The executable must support the '-e' (inline expression) +and '-f' (script file) flags or, at least, ignore them. This allows for any +script or custom executable to be used when a "sed" script is considered +inadequate. + + +=head2 Filtering examples + +As an example, suppose your titles look like this:: + + Artist - Title (radiobanner) + +You can write a sed expression or script containing:: + + s/ (radiobanner)$// + +to remove the trailing part. This facility can also be used to uniform file +names, invert Artist/Title positions and so on. Clever use of the pattern space +can also be used to merge albums. sed alone can be used to debug expressions, +eg:: + + echo "test title" | sed -e 'expr' + +Refer to the sed(1) manual for a complete list of commands you can use. + +=head1 DISCLAIMER + +We would like to remind you that saving streams containing copyrighted material +without explicit consent is *ILLEGAL*. For stream administrators, please see +our statement in the FAQ. + +=head1 SEE ALSO + +bfr <http://www.glines.org/software/bfr> + + Audio-oriented rebuffering tool. Ideal for lousy streams. + +mpgedit <http://www.mpgedit.org/> + + Frame-level mp3 cutting tool. + +=head1 AUTHORS + +fIcy was written by Yuri D'Elia (I<wavexx@users.sf.net>) and +David Leonardi (I<david@mediavitamin.com>) + +This manual page by B. Watson for the SlackBuilds.org project. It may +be used by anyone. diff --git a/audio/fIcy/slack-desc b/audio/fIcy/slack-desc new file mode 100644 index 0000000000..b9859eff52 --- /dev/null +++ b/audio/fIcy/slack-desc @@ -0,0 +1,19 @@ +# HOW TO EDIT THIS FILE: +# The "handy ruler" below makes it easier to edit a package description. +# Line up the first '|' above the ':' following the base package name, and +# the '|' on the right side marks the last column you can put a character in. +# You must make exactly 11 lines for the formatting to be correct. It's also +# customary to leave one space after the ':' except on otherwise blank lines. + + |-----handy-ruler------------------------------------------------------| +fIcy: flcy (icecast/shoutcast stream grabber suite) +fIcy: +fIcy: fIcy is a small icecast/shoutcast stream grabber suite for use under +fIcy: shell environment. Its goal is to automatically rip a stream into user +fIcy: customisable files. It will work with ICY compatible streams, allowing +fIcy: you to either to save the stream to disk or to pipe the output to +fIcy: a media player, or even both. fIcy, among other uses, is ideal for +fIcy: batch/unattended recording of radio programs and stream debugging. +fIcy: +fIcy: +fIcy: |