stream2tracks 0.0.2

data/AUTHORS

@@ -0,0 +1 @@
+Ben Armstrong <synrg@debian.org>

data/COPYING

@@ -0,0 +1,381 @@
+COPYING for stream2tracks
+
+stream2tracks - Download stream as converted, tagged, renamed tracks
+
+    Copyright (c) 2011 by Ben Armstrong <synrg@debian.org>
+
+    Distributed under the terms of the GPL License, version 2 or (at your option)
+    any later version, a copy of which is included below.
+
+    stream2tracks also includes the following files under the following license
+    terms:
+
+setup.rb - a generic installer for Ruby programs
+
+    It was downloaded from http://i.loveruby.net/en/projects/setup/
+
+    Upstream Author: 
+
+        Minero Aoki <aamine@loveruby.net>
+
+    Copyright: 
+
+        Copyright (c) 2000-2005 Minero Aoki
+
+    License:
+
+        This package is free software; you can redistribute it and/or
+        modify it under the terms of the GNU Lesser General Public
+        License as published by the Free Software Foundation, version 2.1 of
+        the License.
+
+        This package is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+        Lesser General Public License for more details.
+
+        You should have received a copy of the GNU Lesser General Public
+        License along with this package; if not, write to the Free Software
+        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+
+-------------------------------------
+
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README

@@ -0,0 +1,84 @@
+stream2tracks-
+
+   A script to download all tracks from a stream container, transcode them all
+   to the desired format, tag them using metadata from the streams and rename
+   them to filenames derived from the tags.
+
+   Currently only asx streams are supported as input and formats that are
+   supported by ffmpeg and taglib2 (e.g. ogg, flac, mp3) are supported as output.
+
+   This code is considered early alpha and therefore is not guaranteed to do
+   anything useful at all. But if the rough edges don't bother you, it's sort
+   of usable already.
+
+Download:
+
+   1. On Debian Wheezy/Sid, install these dependencies. For other platforms,
+      install the equivalents.
+
+      $ sudo apt-get install mimms ffmpeg
+
+   2. Install the gem.
+
+      $ sudo gem install stream2tracks
+
+Usage:
+
+   $ mkdir -p <output-dir>
+   $ cd <output-dir>
+   $ stream2tracks <asx-file-or-url>
+
+   After some time, the script will finish and all output will appear in the
+   current directory. Look in $HOME/.cache/stream2tracks/* if anything went
+   wrong, as currently the working files are not cleaned up.
+
+   The default output format is ogg, and I've tested ogg, mp3 and flac, though
+   any format supported by both ffmpeg and taglib2 should work. So, for
+   example, to output as mp3:
+
+   $ stream2tracks -f mp3 <asx-file-or-url>
+
+   There is an experimental 'multi' mode which downloads all tracks at once.
+   This may work if you have a broadband connection, but could cause problems
+   if you're on a slower link. e.g.
+
+   $ stream2tracks -m <asx-file-or-url>
+
+Where to find streams:
+
+   A number of radio sites archive concerts and other programs as asx streams.
+   I've tested the script with http://www.cbc.ca/radio2/cod so far. There may
+   be some variations in the formats and metadata wrapped in the streams, so
+   I would be happy to hear about your experience using this script with
+   other sites as well.
+
+You can also install from source:
+
+   1. Fetch the source.
+
+      $ git clone git://github.com/synrg/stream2tracks.git
+
+   2a. Build and install the gem.
+
+      $ cd stream2tracks
+      $ rake package
+      $ sudo gem install pkg/stream2tracks*.gem
+
+   2b. Or install using Minero Aoki's setup.rb, e.g.
+
+      $ cd stream2tracks
+      $ ruby setup.rb config --prefix=/usr/local
+      $ sudo ruby setup.rb install
+
+      See setup.rb --help for other possible options.
+
+Bugs:
+
+   Please file and track issues at the project site:
+
+      https://github.com/synrg/stream2tracks
+
+   The preferred way to contact me about bugs, including documentation bugs
+   or wishlists is through the issues system.
+
+Ben Armstrong <synrg@debian.org>

data/TODO

@@ -0,0 +1,8 @@
+- support input formats other than asx (must support titles for tagging)
+- provide a more proper project structure: lib, bin, test/rspec/cucumber, Rakefile
+- put code under test
+- packaging (setup, gem, debian)
+- write a man page
+- serialize intermediate results and save to make it possible to
+  reprocess stream, picking up where we left off if the rip was
+  aborted

data/bin/stream2tracks

@@ -0,0 +1,12 @@
+#! /usr/bin/ruby
+
+$:.unshift(File.dirname(__FILE__ + '.rb') + '/../lib')
+
+begin
+    require 'sfl' # For ruby 1.8 compatibility
+rescue LoadError
+end
+
+require 'stream2tracks/cli'
+
+stream2tracks ARGV

data/lib/stream2tracks.rb

@@ -0,0 +1,2 @@
+require 'stream2tracks/stream_track_ripper'
+require 'stream2tracks/cli'

data/lib/stream2tracks/asx_stream.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+require 'stream2tracks/stream'
+
+class ASXStream < Stream
+    def entries
+	xml.css('ENTRY')
+    end
+
+    def parse
+	title=xml.css('ASX>TITLE')[0]
+	album=title.inner_text if title
+	@tags[:album]=album
+	count=0
+	tracks=[]
+	entries.each do |_|
+	    tags=@tags.dup
+	    count+=1
+	    tags.merge!(
+		:title=>_.css('TITLE').inner_text,
+		:artist=>_.css('AUTHOR').inner_text,
+		:track=>count
+	    )
+	    track=Track.new tags,_.css('REF')[0]['HREF']
+	    tracks << track
+	end
+	tracks
+    end
+
+    private
+
+    def xml
+	@xml||=Nokogiri::XML(@raw)
+    end
+end
+

data/lib/stream2tracks/cli.rb

@@ -0,0 +1,47 @@
+require 'optparse'
+require 'ostruct'
+require 'stream2tracks/stream_track_ripper'
+
+def stream2tracks argv
+    options=OpenStruct.new
+    options.format='ogg'
+    options.multi=false
+    options.debug=false
+    options.log=nil
+
+    OptionParser.new do |opts|
+	opts.on('-d','--debug','Output debugging info.') do
+	    options.debug=true
+	end
+
+	opts.on('-f','--format FORMAT','Convert tracks to FORMAT (default %s).' % options.format) do |format|
+	    options.format=format
+	end
+
+	opts.on('-l','--log FILENAME','Log to FILENAME (or - for standard error).') do |filename|
+	    options.log=filename
+	end
+
+	opts.on('-m','--multi','Download multiple tracks at once (EXPERIMENTAL).') do
+	    options.multi=true
+	end
+
+	opts.on('-q','--quiet','Suppress output (progress bar).') do
+	    options.quiet=true
+	end
+
+	opts.on_tail('-h', '--help', 'Show this message.') do
+	    puts opts
+	    exit
+	end
+
+	opts.on_tail('--version', 'Show version.') do
+	    puts StreamTrackRipper::Version.join('.')
+	    exit
+	end
+    end.parse! argv
+
+    input_filename=argv.shift
+
+    StreamTrackRipper.new(ASXStream.new(input_filename),options){}
+end

data/lib/stream2tracks/process.rb

@@ -0,0 +1,80 @@
+require 'progressbar'
+
+# A WatchedProcessGroup is a group of processes running in parallel,
+# all of which can collectively be watched to indicate progress so far.
+# It also supports visually representing progress of all processes
+# in the group as a progress bar.
+class WatchedProcessGroup < Array
+    def watch options
+	@bar=nil
+	update_bar=proc do |current,total|
+	    # FIXME: remove hardwired 'Downloading' label
+	    @bar=ProgressBar.new('Downloading',total) if total!=@old_total or @bar.nil?
+	    @old_total=total
+	    @bar.set current
+	end
+
+	all_done=false
+
+	until all_done do
+	    all_done=true
+	    current,@old_total,total=0,0,0
+	    each do |_|
+		begin
+		    status=_.watch options
+		rescue RuntimeError => e
+		    # FIXME: @log belongs to StreamTrackRipper instance, not WatchedProcessGroup!
+		    # TODO: wrap in an error handler to both log and print to stderr
+		    @log.error e.message
+		    $stderr.puts "\nE: %s: %s" % [@cmd,e.message]
+		    delete _
+		end
+		if status.current
+		    # The reported totals may not be accurate. Rather
+		    # than recompute the actual total when the track
+		    # finishes, just accumulate the reported total
+		    # to improve accuracy of the progress bar.
+		    current+=status.eof ? status.total : status.current
+		    total+=status.total
+		end
+		all_done=false unless status.eof
+	    end
+	    update_bar[current,total] if total>0
+	end
+
+	@bar.finish if @bar
+    end
+end
+
+# A WatchedProcess is a process producing output which can be watched
+# to indicate progress so far and validate output.
+# - It supports these behaviours with the following callbacks:
+#    progress[@buffer] => [current,total]
+#    validate[@buffer] => true when download is complete and successful
+#    - validate may raise if an unrecoverable error occurs before the
+#      process is complete
+class WatchedProcess
+    MAX_READ_LEN=1024 # completely arbitrary
+    class Status < Struct.new :eof,:valid,:current,:total ; end
+
+    def initialize cmd
+	@out,out_write=IO.pipe
+	@cmd=cmd
+	@pid=spawn @cmd,:in=>:close,:out=>out_write,:err=>[:child,:out]
+	out_write.close
+	yield self if block_given?
+    end
+
+    def watch options
+	progress,validate=options.progress,options.validate
+	@buffer||=''
+	output=@out.readpartial MAX_READ_LEN rescue EOFError
+	@buffer << output if output
+	$stderr.print output if options.debug and output
+	current,total=progress[@buffer] if progress
+	eof=@out.eof?
+	valid=validate[@buffer] if validate
+	Status.new eof,valid,current,total
+    end
+end
+

data/lib/stream2tracks/stream.rb

@@ -0,0 +1,49 @@
+require 'digest/md5'
+require 'open-uri'
+
+# A Stream is an abstraction of the input audio stream container that has:
+# - a path, either a URI or filename
+# - a key, uniquely identifying the stream
+# - some metadata about the stream (Tags)
+# - some entries
+#
+# Tags are metadata about a stream, its entries or a Track
+#
+# A Track is separate entry from a stream, containing:
+# - some metadata about the track (Tags)
+# - a URI
+#
+# A TrackFile is a file produced from a stream, containing:
+# - some metadata about the track (Tags)
+# - the filename
+# - the format of the file
+
+class Tags < Hash ; end
+
+# TODO: perhaps delegate to tags via method_missing?
+class Track < Struct.new :tags,:uri ; end
+
+class TrackFile < Struct.new :tags,:filename,:format ; end
+
+# An abstract class
+class Stream
+    attr_accessor :tags,:key
+
+    def initialize path
+	@path=path
+	file=open(@path)
+	@raw=file.read
+	@tags=Tags.new
+    end
+
+    # To be implemented in the concrete subclass
+    def entries ; end
+
+    def key
+	@key||=Digest::MD5.new.hexdigest(@raw).to_s
+    end
+
+    # To be implemented in the concrete subclass
+    def parse ; end
+end
+

data/lib/stream2tracks/stream_track_ripper.rb

@@ -0,0 +1,132 @@
+require 'logger'
+require 'taglib'
+require 'fileutils'
+include FileUtils
+require 'stream2tracks/asx_stream'
+require 'stream2tracks/process'
+
+class StreamTrackRipper
+    Version=['0','0','2']
+
+    def initialize stream,options
+	@stream=stream
+	@options=options
+	@log=Logger.new @options.log=='-' ? $stderr : @options.log if @options.log
+	@tracks=@stream.parse
+	@log.info 'Processing stream: %s' % @stream.key if @log
+	@log.info 'Found %i tracks' % @tracks.count if @log
+	album=@stream.tags[:album]
+	@log.info 'Found stream title: %s' % album if @log and album
+	@curdir=Dir.pwd
+	@workdir=File.join(ENV['HOME'],'.cache','stream2tracks',@stream.key)
+	mkdir_p @workdir
+	if block_given?
+	    # TODO: support (re)processing selected tracks from any stage
+	    trackfiles=get @tracks
+	    trackfiles=convert trackfiles,@options.format
+	    trackfiles=tag trackfiles
+	    @trackfiles=rename trackfiles
+	    yield
+	end
+	# TODO: report on any failures
+    end
+
+    TO_BYTES={'GB'=>1000000000,'MB'=>1000000,'KB'=>1000}
+    def get tracks
+	trackfiles=[]
+	processes=WatchedProcessGroup.new
+	options=@options.dup
+	unless options.quiet
+	    options.progress=proc do |buffer|
+		current,total=if buffer.scan(/(\d+\.\d+) (.B) \/ (\d+\.\d+) (.B)/m).last
+		    cur,cur_unit,tot,tot_unit=$1,$2,$3,$4
+		    [(cur.to_f*TO_BYTES[cur_unit.upcase]).to_i,
+		     (tot.to_f*TO_BYTES[tot_unit.upcase]).to_i]
+		end
+		[current,total]
+	    end
+	    options.validate=proc do |buffer|
+		raise 'libmms connection error' if buffer.include? 'libmms error: libmms connection error'
+		buffer.include? 'Download complete!'
+	    end
+	end
+	tracks.each do |track|
+	    tags=track.tags
+	    # TODO: support formats which may not be possible to determine
+	    # from the file extension of the entry in the stream (using
+	    # magic number from file itself).
+	    format=File.extname(File.basename(track.uri)).sub(/^\./,'')
+	    @log.info 'Track tags: %s' % tags.inspect if @log
+	    output_filename=File.join @workdir,'%02d.%s' % [tags[:track],format]
+	    if File.exists? output_filename
+		@log.info 'Discarding old partial output: %s' % output_filename if @options.log
+		rm output_filename
+	    end
+	    cmd='mimms "%s" "%s"' % [track.uri,output_filename]
+	    @log.info 'Spawning: %s' % cmd if @log
+	    processes << WatchedProcess.new(cmd)
+	    trackfiles << TrackFile.new(tags,output_filename,format)
+	    processes[-1,1].watch options unless @options.multi
+	end
+	processes.watch options if @options.multi
+	trackfiles
+    end
+
+    def convert trackfiles,format
+	trackfiles.each do |trackfile|
+	    tags=trackfile.tags
+	    input_filename=trackfile.filename
+	    output_filename=File.join @workdir,'%02d.%s' % [tags[:track],format]
+	    cmd=case format
+	    when 'ogg'
+		'ffmpeg -i "%s" -acodec libvorbis "%s"' %
+		    [input_filename,output_filename]
+	    else # e.g. mp3, flac
+		'ffmpeg -i "%s" "%s"' %
+		    [input_filename,output_filename]
+	    end
+	    @log.info 'Spawning: %s' % cmd if @log
+	    WatchedProcessGroup.new([WatchedProcess.new(cmd)]).watch(@options)
+	    rm input_filename
+	    trackfile.filename=output_filename
+	    trackfile.format=format
+	end
+	trackfiles
+    end
+
+    def tag trackfiles
+	trackfiles.each do |trackfile|
+	    @log.info 'Tagging: %s' % trackfile.filename if @log
+	    tags=trackfile.tags
+	    file=TagLib::File.new trackfile.filename
+	    file.album  = tags[:album] if tags[:album]
+	    file.title  = tags[:title]
+	    file.artist = tags[:artist]
+	    file.track  = tags[:track]
+	    file.save
+	end
+	trackfiles
+    end
+
+    def rename trackfiles
+	trackfiles.each do |trackfile|
+	    tags=trackfile.tags
+	    input_filename=trackfile.filename
+	    output_filename='%02d-%s-%s.%s' %
+		[tags[:track],tags[:album] ?
+		    tags[:album] :
+		    tags[:artist],tags[:title],
+		trackfile.format]
+	    # Strip characters that could cause problems for some target filesystems
+	    output_filename.gsub!(/[:\/\\]/,' ')
+	    # And reduce any blanks to underscores as a shell typing aid
+	    output_filename.gsub!(/ +/,'_')
+
+	    @log.info 'Renaming: %s to: %s' % [input_filename,output_filename] if @log
+	    mv input_filename,output_filename
+	    trackfile.filename=output_filename
+	end
+	trackfiles
+    end
+end
+

data/spec/stream2tracks/stream_spec.rb

@@ -0,0 +1,6 @@
+describe 'Stream' do
+    describe '.new' do
+    end
+    describe '#key' do
+    end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: stream2tracks
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ben Armstrong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &10413680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10413680
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: &10413220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10413220
+- !ruby/object:Gem::Dependency
+  name: sfl
+  requirement: &10429140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10429140
+- !ruby/object:Gem::Dependency
+  name: taglib2
+  requirement: &10428660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10428660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &10428020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10428020
+description: Stream ripper and tagger supporting asx, ogg, mp3, flac, etc.
+email: synrg@debian.org
+executables:
+- stream2tracks
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- AUTHORS
+- README
+- TODO
+- COPYING
+- bin/stream2tracks
+- spec/stream2tracks/stream_spec.rb
+- lib/stream2tracks/process.rb
+- lib/stream2tracks/asx_stream.rb
+- lib/stream2tracks/cli.rb
+- lib/stream2tracks/stream.rb
+- lib/stream2tracks/stream_track_ripper.rb
+- lib/stream2tracks.rb
+homepage: http://github.com/synrg/stream2tracks
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Download stream as converted, tagged, renamed tracks; asx input and ogg,
+  mp3, flac, etc. output supported.
+test_files: []