ripperX is a graphical interface to CD rippers and MP3/OGG/FLAC encoders.
It is released under the GNU GPL.
For more information please read the COPYING file.

http://ripperx.sf.net
=====================================================================

If you have any suggestions or bug reports, please mail us at:

Tony Mancill <tmancill@users.sourceforge.net>
  and/or
Dave Cinege <dcinege@psychosis.com>

Note that we're anticipating bugs, and hence more frequent releases.
Therefore, release numbering will be 2.7.x to indicate bugfix/patch
releases between functionality releases (i.e. 2.7 -> 2.8).

Also of note is that primary development is being done on Debian now,
not RedHat, so we welcome input from other distro users on how to make
life easier for them in order to accomodate them as much as possible.

Have fun.

Note: jos.dehaes@bigfoot.com no longer maintains ripperX

This package contains source codes for
i   . ripperX plugin tester ( ripperX_plugin_tester.c )
ii  . ripperX plugin for cdparanoia ( ripperX_plugin-cdparanoia.c )
iii . ripperX plugin for 8hz-mp3  ( ripperX_plugin-8hz-mp3.c )

and documentations describing
i   . ripperX plugin specifications ( README.plugin_spec_v0.1 )
ii  . how to use ripperX plugin tester ( README.plugin_tester )

I tested cdparanoia plugin with cdparanoia III alpha prerelease 8 but it
should work with more recent versions and I think the 8hz-mp3 plugin also
should work with the versions most people have.

==========================================================================
					ripperX_plugin_devel_package_v0.1
							       TeJun, Huh
					 	wineking@adam.kaist.ac.kr

ripperX plugin specification v0.1

This document describes the way ripperX plugins work.

1. ripperX plugin?

 ripperx plugin is just a program which interprets the output of various
rippers/encoders into the form ripperX understands so that I don't have to
mess with the source code of ripperX to add support for ripperA or encoderB.
;-)


2. The way program/plugin/ripperX communicates.

 ripperX will take care of the linkage among ripper/encoder, plugin and
ripperX. The linkage will look like the following.

                /-stdout-\ pty/tty          /-stdout-\ pty/tty
 ripper/encoder-          ---------> plugin-          ---------> ripperX
                \-stderr-/                  \-stderr-
		                                     \
						      -> default stderr

Plugin can just read from stdin and write the result to stdout. Both stdout
and stderr of ripper/encoder are redirected to stdin of plugin, and stderr of
plugin is not modified.


3. Plugin arguments

 When a plugin is invoked by ripperX, it will be given two arguments. The
first one is the beginning sector of currently processed track, and the second
argument is the length of currently processed track in sector. You can use
this information to caculate the progress.

4. The format of plugin output.

 The output of plugin consists of three parts - type, progress, msg. The type
field tells ripperX what kind of msg it is sending. Available types are
 i   ) P : normal reporting of progress w/ or w/o msg. P reporting must have
 	   progress field. If it has a msg, it will be displayed in the status
	   bar of ripperX.
 ii  ) W : warning. If ripperX receives warning msg, it will display the msg
 	   using dialog box but will not halt/abort current job. It must
	   contain non-null msg field.
 iii ) E : error. If ripperX receives error msg, it will display the msg using
           dialog box and halts the job and asks the user if he/she wants to
	   abort current job. It must contain non-null msg field.

 The progress field tells ripperX how much the ripping/encoding has
progressed. It is a floating point number between 0 and 1.
 The msg field is described above.

 The format looks like

 [type progress "msg"]'\n'
      |        |
       \---------------> space
 examples)

 [P 0.12345 "----->            "]
 [P 0.32321]
 [W "Hey there."]
 [E "Hello world!"]

 Every reporting must be followed by a new-line character.


5. How often does a plugin have to print out the reporting?

 Plugin should print out a reporting every 0.5 seconds(+- a little bit is just
 fine) and also should print only one reporting at a time. Also plugins should
 print nothing when the ripper/encoder is finished. Plugins can skip printing
 report if it doesn't want to.

==============================================================================
					     ripperX plugin specification v0.1
								    TeJun, Huh
						     wineking@adam.kaist.ac.kr

ripperX plugin tester v0.1

This document describes what ripperX_plugin_tester is and how to use it.

1. ripperX_plugin_tester?

 ripperX_plugin_tester is a program with which one can test if a plugin he/she
wrote works fine. It is essentially made from the code segments from ripperX
which handles execution of ripper/encoder/plugin and the parsing of output
from plugin. So if a plugin looks fine when tested with ripperX_plugin_tester,
it should work with ripperX.


2. How do I use it?

 The syntax is

 $ ripperX_plugin_tester "ripper/encoder command" "plugin command"

 for example, to test cdparanoia plugin.

 $ ripperX_plugin_tester "cdparanoia 4" "ripperX_plugin-cdparanoia 31987 4215

 After executing ripperX_plugin_tester like above, if everything goes ok,
you'll see output like this

***Executing "cdparanoia 4"
with plugin "./ripperX_plugin-cdparanoia 31987 4215"

*** No report available from plugin. Ctrl-C to stop
*** PLUGIN_MSG_PARSE_ERR returned

*** No report available from plugin. Ctrl-C to stop
*** PLUGIN_MSG_PARSE_ERR returned

*** No report available from plugin. Ctrl-C to stop
*** PLUGIN_MSG_PARSE_ERR returned

*** No report available from plugin. Ctrl-C to stop
*** PLUGIN_MSG_PARSE_ERR returned

*** No report available from plugin. Ctrl-C to stop
*** PLUGIN_MSG_PARSE_ERR returned

*** Output read from plugin : [P 0.055991 "-->                           "]
Report type : progress, Progress : 0.055991,
Msg : -->

*** Output read from plugin : [P 0.092527 "-+->                          "]
Report type : progress, Progress : 0.092527,
Msg : -+->

 If something goes wrong, it will print out error msgs. The error msgs are
quite easy. I think you can figure what's wrong when an error msg appears.

==============================================================================
						    ripperX_plugin_tester v0.1
								    TeJun, Huh
						     wineking@adam.kaist.ac.kr