[ViewVC] Annotation of: cvs/Algorithm-FEC/README

NAME
    Algorithm::FEC - Forward Error Correction using Vandermonde Matrices

SYNOPSIS
     use Algorithm::FEC;

DESCRIPTION
    This module is an interface to the fec library by Luigi Rizzo et al.,
    see the file README.fec in the distribution for more details.

    This library implements a simple ("encoded_blocks","data_blocks")
    erasure code based on Vandermonde matrices. The encoder takes
    "data_blocks" blocks of size "block_size" each, and is able to produce
    up to "encoded_blocks" different encoded blocks, numbered from 0 to
    "encoded_blocks-1", such that any subset of "data_blocks" members
    permits reconstruction of the original data.

    Allowed values for "data_blocks" and "encoded_blocks" must obey the
    following equation:

       data_blocks <= encoded_blocks <= MAXBLOCKS

    Where "MAXBLOCKS=256" for the fast implementation and "MAXBLOCKS=65536"
    for the slow implementation (the implementation is chosen
    automatically).

    $fec = new Algorithm::FEC $data_blocks, $encoded_blocks, $blocksize
        Creates a new Algorithm::FEC object with the given parameters.

    $fec->set_encode_blocks ([array_of_blocks])
        Sets the data blocks used for the encoding. Each member of the array
        can either be:

        * a string of size "blocksize" "exactly".
            This is useful for small files (encoding entirely in memory).

        * a filehandle of a file of size "blocksize" "exactly".
            This is useful when the amount of data is large and resides in
            single files.

        * a reference to an array containing a filehandle and, optionally,
        an offset into that file.
            This is useful if the amount of data is large and resides in a
            single file. Needless to say, all parts must not overlap and
            must fit into the file.

        If your data is not of the required size (i.e. a multiple of
        "blocksize" bytes), then you must pad it (e.g. with zero bytes) on
        encoding (and you should truncate it after decoding). Otherwise,
        this library croaks.

        Future versions might instead load the short segment into memory or
        extend your scalar (this might enable nice tricks, like "$fec-"copy
        (..., my $x)> :). Mail me if you want this to happen.

        If called without arguments, the internal storage associated with
        the blocks is freed again.

    $block = $fec->encode ($block_index)
        Creates a single encoded block of index "block_index", which must be
        between 0 and "encoded_blocks-1" (inclusive). The blocks from 0 to
        "data_blocks-1" are simply copies of the original data blocks.

        The encoded block is returned as a perl scalar (so the blocks should
        fit into memory. If this is a problem for you mail me and I'll make
        it a file.

    $fec->set_decode_blocks ([array_of_blocks], [array_of_indices])
        Prepares to decode "data_blocks" of blocks (see "set_encode_blocks"
        for the "array_of_blocks" parameter).

        Since these are not usually the original data blocks, an array of
        indices (ranging from 0 to "encoded_blocks-1") must be supplied as
        the second arrayref.

        Both arrays must have exactly "data_blocks" entries.

        This method also reorders the blocks and index array in place (if
        necessary) to reflect the order the blocks will have in the decoded
        result.

        The index array represents the decoded ordering, in that the n-th
        entry in the indices array corresponds to the n-th data block of the
        decoded result. The value stored in the n-th place in the array will
        contain the index of the encoded data block.

        Input blocks with indices less than "data_blocks" will be moved to
        their final position (block k to position k), while the gaps between
        them will be filled with check blocks. The decoding process will not
        modify the already decoded data blocks, but will modify the check
        blocks.

        That is, if you call this function with "indices = [4,3,1]", with
        "data_blocks = 3", then this array will be returned: "[0,2,1]". This
        means that input block 0 corresponds to file block 0, input block 1
        to file block 2 and input block 2 to data block 1.

        You can just iterate over this array and write out the corresponding
        data block (although this is inefficient):

           for my $i (0 .. $#idx)
              if ($idx[$i] != $i) # need we move this block?
                 copy encoded block $idx[$i] to position $i
              }
           }

        The "copy" method can be helpful here.

        This method destroys the block array as set up by
        "set_encode_blocks".

    $fec->shuffle ([array_of_blocks], [array_of_indices])
        The same same as "set_decode_blocks", with the exception that the
        blocks are not actually set for decoding.

        This method is not normally used, but if you want to move blocks
        around after reordering and before decoding, then calling "shuffle"
        followed by "set_decode_blocks" incurs lower overhead than calling
        "set_decode_blocks" twice, as files are not mmapped etc.

    $fec->decode
        Decode the blocks set by a prior call to "set_decode_blocks".

        This method destroys the block array as set up by
        "set_decode_blocks".

    $fec->copy ($srcblock, $dstblock)
        Utility function that simply copies one block (specified like in
        "set_encode_blocks") into another. This, btw., destroys the blocks
        set by "set_*_blocks".

COMPATIBILITY
    The way this module works is compatible with the way freenet
    (<http://freenet.sf.net>) encodes files. Comaptibility to other file
    formats or networks is not known, please tell me if you find more
    examples.

SEE ALSO
    Net::FCP. And the author, who might be happy to receive mail from any
    user, just to see that this rather rarely-used module is actually being
    used (except for freenet ;)

BUGS
     * too complicated.
     * largely untested, please change this.
     * file descriptors are not supported, but should be.
     * utility functions for files should be provided.
     * 16 bit version not tested

AUTHOR
     Marc Lehmann <schmorp@schmorp.de>
     http://home.schmorp.de

Revision:	1.7
Committed:	Sun Dec 23 15:43:27 2007 UTC (18 years, 8 months ago) by root
Branch:	MAIN
CVS Tags:	rel-1_0
Changes since 1.6:	+9 -9 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	NAME
2	root	1.2	Algorithm::FEC - Forward Error Correction using Vandermonde Matrices
3	root	1.1
4			SYNOPSIS
5	root	1.2	use Algorithm::FEC;
6	root	1.1
7			DESCRIPTION
8			This module is an interface to the fec library by Luigi Rizzo et al.,
9			see the file README.fec in the distribution for more details.
10
11	root	1.4	This library implements a simple ("encoded_blocks","data_blocks")
12	root	1.1	erasure code based on Vandermonde matrices. The encoder takes
13	root	1.4	"data_blocks" blocks of size "block_size" each, and is able to produce
14			up to "encoded_blocks" different encoded blocks, numbered from 0 to
15			"encoded_blocks-1", such that any subset of "data_blocks" members
16	root	1.1	permits reconstruction of the original data.
17
18	root	1.4	Allowed values for "data_blocks" and "encoded_blocks" must obey the
19	root	1.1	following equation:
20
21	root	1.4	data_blocks <= encoded_blocks <= MAXBLOCKS
22	root	1.1
23			Where "MAXBLOCKS=256" for the fast implementation and "MAXBLOCKS=65536"
24			for the slow implementation (the implementation is chosen
25			automatically).
26
27	root	1.7	$fec = new Algorithm::FEC $data_blocks, $encoded_blocks, $blocksize
28			Creates a new Algorithm::FEC object with the given parameters.
29
30	root	1.4	$fec->set_encode_blocks ([array_of_blocks])
31	root	1.1	Sets the data blocks used for the encoding. Each member of the array
32			can either be:
33
34			* a string of size "blocksize" "exactly".
35			This is useful for small files (encoding entirely in memory).
36
37			* a filehandle of a file of size "blocksize" "exactly".
38			This is useful when the amount of data is large and resides in
39			single files.
40
41			* a reference to an array containing a filehandle and, optionally,
42			an offset into that file.
43			This is useful if the amount of data is large and resides in a
44			single file. Needless to say, all parts must not overlap and
45			must fit into the file.
46
47			If your data is not of the required size (i.e. a multiple of
48			"blocksize" bytes), then you must pad it (e.g. with zero bytes) on
49	root	1.5	encoding (and you should truncate it after decoding). Otherwise,
50			this library croaks.
51
52			Future versions might instead load the short segment into memory or
53			extend your scalar (this might enable nice tricks, like "$fec-"copy
54			(..., my $x)> :). Mail me if you want this to happen.
55	root	1.1
56			If called without arguments, the internal storage associated with
57			the blocks is freed again.
58
59	root	1.7	$block = $fec->encode ($block_index)
60	root	1.4	Creates a single encoded block of index "block_index", which must be
61			between 0 and "encoded_blocks-1" (inclusive). The blocks from 0 to
62			"data_blocks-1" are simply copies of the original data blocks.
63	root	1.1
64			The encoded block is returned as a perl scalar (so the blocks should
65			fit into memory. If this is a problem for you mail me and I'll make
66			it a file.
67
68	root	1.4	$fec->set_decode_blocks ([array_of_blocks], [array_of_indices])
69			Prepares to decode "data_blocks" of blocks (see "set_encode_blocks"
70			for the "array_of_blocks" parameter).
71	root	1.1
72	root	1.7	Since these are not usually the original data blocks, an array of
73			indices (ranging from 0 to "encoded_blocks-1") must be supplied as
74			the second arrayref.
75	root	1.1
76	root	1.4	Both arrays must have exactly "data_blocks" entries.
77	root	1.1
78	root	1.4	This method also reorders the blocks and index array in place (if
79			necessary) to reflect the order the blocks will have in the decoded
80			result.
81
82			The index array represents the decoded ordering, in that the n-th
83			entry in the indices array corresponds to the n-th data block of the
84			decoded result. The value stored in the n-th place in the array will
85			contain the index of the encoded data block.
86
87			Input blocks with indices less than "data_blocks" will be moved to
88			their final position (block k to position k), while the gaps between
89			them will be filled with check blocks. The decoding process will not
90			modify the already decoded data blocks, but will modify the check
91			blocks.
92	root	1.1
93			That is, if you call this function with "indices = [4,3,1]", with
94	root	1.4	"data_blocks = 3", then this array will be returned: "[0,2,1]". This
95			means that input block 0 corresponds to file block 0, input block 1
96			to file block 2 and input block 2 to data block 1.
97	root	1.1
98			You can just iterate over this array and write out the corresponding
99	root	1.3	data block (although this is inefficient):
100
101	root	1.4	for my $i (0 .. $#idx)
102			if ($idx[$i] != $i) # need we move this block?
103			copy encoded block $idx[$i] to position $i
104			}
105	root	1.3	}
106	root	1.1
107	root	1.4	The "copy" method can be helpful here.
108	root	1.1
109	root	1.4	This method destroys the block array as set up by
110			"set_encode_blocks".
111
112			$fec->shuffle ([array_of_blocks], [array_of_indices])
113			The same same as "set_decode_blocks", with the exception that the
114			blocks are not actually set for decoding.
115
116			This method is not normally used, but if you want to move blocks
117	root	1.7	around after reordering and before decoding, then calling "shuffle"
118	root	1.4	followed by "set_decode_blocks" incurs lower overhead than calling
119			"set_decode_blocks" twice, as files are not mmapped etc.
120
121			$fec->decode
122			Decode the blocks set by a prior call to "set_decode_blocks".
123
124			This method destroys the block array as set up by
125			"set_decode_blocks".
126	root	1.1
127	root	1.2	$fec->copy ($srcblock, $dstblock)
128	root	1.1	Utility function that simply copies one block (specified like in
129	root	1.4	"set_encode_blocks") into another. This, btw., destroys the blocks
130			set by "set_*_blocks".
131	root	1.1
132	root	1.5	COMPATIBILITY
133			The way this module works is compatible with the way freenet
134			(<http://freenet.sf.net>) encodes files. Comaptibility to other file
135	root	1.7	formats or networks is not known, please tell me if you find more
136	root	1.5	examples.
137	root	1.1
138			SEE ALSO
139	root	1.5	Net::FCP. And the author, who might be happy to receive mail from any
140			user, just to see that this rather rarely-used module is actually being
141			used (except for freenet ;)
142	root	1.1
143			BUGS
144	root	1.5	* too complicated.
145			* largely untested, please change this.
146			* file descriptors are not supported, but should be.
147			* utility functions for files should be provided.
148			* 16 bit version not tested
149	root	1.1
150			AUTHOR
151	root	1.6	Marc Lehmann <schmorp@schmorp.de>
152	root	1.5	http://home.schmorp.de
153	root	1.1