project/pipebuf/Index.pm

   1 # $Id$
   2 # Main page of 'My::Project::pipebuf'
   3 # Copyright (C) 2003-2005 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; exactly version 2 of June 1991 is required
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17
  18
  19 package project::pipebuf::Index;
  20 require 5.6.0;  # at least 'use warnings;' but we need some 5.6.0+ modules anyway
  21 our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
  22 our $CVS_ID=q$Id$;
  23 use strict;
  24 use warnings;
  25
  26 use My::Web;
  27 Wuse 'project::Lib';
  28
  29
  30 our @ListItem=(
  31                 "name"=>"pipebuf",
  32                 "platform"=>"unixuser",
  33                 "priority"=>440,
  34                 "download"=>"pipebuf.c",
  35                 "summary"=>"UNIX pipe realtime buffering",
  36                 "license"=>"PD",
  37                 "maintenance"=>"ready",
  38                 "language"=>"C",
  39                 "description"=><<"HERE",
  40 <p>You can buffer realtime data such as audio stream by inserting this program
  41 with traditional &quot;UNIX filter&quot; behaviour. It reads as fast as possible into
  42 its cache and also in the same time writes as fast as possible to the output.</p>
  43 HERE
  44                 );
  45
  46 sub handler
  47 {
  48 project::Lib->init();
  49
  50
  51 print <<"HERE";
  52 <p>Progarm is implemented as two processes (no threads - no pthread libraries
  53 needed, only IPC communication used). Features custom buffer sizes, prefill
  54 (start writing of the first byte only after the WHOLE buffer has beel filled
  55 up) and warning messages when buffer is getting emptied.</p>
  56 HERE
  57
  58
  59 exit;
  60 }
  61 1;