File	Date	Author	Commit
.gitignore	2014-08-20	Egor Sanin	[888c99] Updated .gitignore for distutils
AUTHORS	2015-02-10	Egor Sanin	[957c90] Updated copyright year.
CHANGELOG	2014-10-04	Egor Sanin	[546b34] Added changelog.
COPYING	2014-03-08	Egor Sanin	[76a72d] Added GNU package files.
INSTALL	2014-08-20	Egor Sanin	[065557] Updated some info.
MANIFEST.in	2014-08-20	Egor Sanin	[10a6ef] Added distutils files.
README	2014-10-04	Egor Sanin	[6feddb] Updated notes in README
hrec	2015-02-12	Egor Sanin	[cf5550] Using regex to check jack clients.
setup.py	2014-09-21	Egor Sanin	[448f47] Make 0.2 release.

Read Me

hrec 0.2

hrec is designed to be a simple program for audio recording in a jackd environment.
 hrec is written in python and is a front-end to ecasound, you will need to following software installed in order to actually use hrec:
jackd
ecasound
curses
python2

And optionally, for some functionality:
Jmeters (meter support)
lame (mp3 output)
vorbis-tools (ogg output)
FLAC (flac output)
FAAC/FAAD2 (aac/.m4a/.mp4 outout)


Invocation

usage: hrec [-h] [-v] [-c CHANNELS] [-r DIRECTORY] [-p PORT] [-j JACKCLIENT]
            [-f FORMAT] [-e EXTENSION] [-F] [-m]

Program for simple audio recording

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -c CHANNELS, --channels CHANNELS
                        number of channels to record
  -r DIRECTORY, --directory DIRECTORY
                        directory to put recordings -- this must exist
  -p PORT, --port PORT  starting input port number
  -j JACKCLIENT, --jackclient JACKCLIENT
                        client name and prefix to record from
  -b BITS, --bits BITS  specify sample bits, but make sure the output format
                        supports this, if other than wav; supported: u8, s16,
                        s24, s32, f32
  -e EXTENSION, --extension EXTENSION
                        write to something other than wav, mp3, ogg, aac, flac
                        supported, but requires appropriate codecs, see: http:
                        //ecasound.sourceforge.net/ecasound/requirements.php
  -F, --force           force hrec even if jack is not running NOT RECOMMENDED
  -m, --meters          launch Jmeters for connected channels, if installed


Operation

hrec is operated with single key strokes:
r start recording
s stop recording
q quit hrec
m mute/unmute monitor chain
arrow keys scroll track list

Notes:

When the output file is set to something other than wav, the
bitdepth value seems to be ignored.  Support for anything other
that wav is still experimental in hrec.
Please report bugs.

Jack client nuances:
hrec can handle most clients, however, it is not designed to
be a 100% robust catch-all, and there are cases where hrec
will fail to recognize the proper client ports and thus be unable
to connect for recording and/or playback.
In this case, please contact the authors and provide a report on
the specific problem setup.
We cannot promise to be able to accommodate all possible scenarios,
and sometimes, you will simply have to use a more sophisticated
tool for your work.
Some of the problem areas are firewire ports that are names in elaborate
ways, and jack clients that do not follow the `client:type_N' naming
convention.

For help, contact author.

For Installation instructions, see INSTALL