The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Math::DCT - 1D and NxN 2D Fast Discreet Cosine Transforms (DCT-II)

SYNOPSIS

    use Math::DCT qw/dct dct1d dct2d idct1d idct2d/;

    my $dct1d = dct([[1,2,3,4]]);
    $dct1d = dct1d([1,2,3,4]);

    my $dct2d = dct([[1,2],[3,4]]);
    $dct2d = dct2d([1,2,3,4]);

    my $idct1d = idct1d([1,2,3,4]);
    my $idct2d = idct2d([1,2,3,4]);

VERSION

Version 0.04_0

DESCRIPTION

An unscaled DCT-II implementation for 1D and NxN 2D matrices implemented in XS. For array sizes which are a power of 2, a fast algorithm (FCT) described by Lee is used (with the addition of a coefficient table that makes it even faster than some common implementations), plus an unscaled version of the Arai, Agui, Nakajima algorithm is used for size 1x8, 8x8 matrices. A less optimized algorithm is used for the generic case, so any 1D or square 2D matrix can be processed.

For convenience the inverse functions are provided (inverse DCT-II, usually called iDCT, is essentially a scaled DCT-III), although using just one generic algorithm.

The module was written for a perceptual hash project that needed 32x32 DCT-II, and on a 2.5GHz i7 2015 Macbook Pro about 18000/s per thread are processed (dct2d function). The common 8x8 DCT-II uses a special path, (about 380000/s on that same CPU), although for most image/video applications that require 8x8 DCT there are much faster implementations (SIMD, approximations etc) that usually produce an already scaled result for the specific application.

None of the algorithms used on this module are approximate, the test suite verifies against a naive DCT-II implementation with a tolerance of 1e-08.

METHODS

dct

  my $dct = dct([[1,2],[3,4]]);

Pass an array (ref) of either a single array, or N N-length arrays for 1D and 2D DCT-II calculation respectivelly. The output will be an arrayref of array(s) with the result of the transform.

dct1d

  my $dct = dct1d([1,2,3]);

Pass an array (ref) for a 1D DCT-II calculation. The output will be an arrayref with the result of the transform.

idct1d

  my $idct = idct1d([1,2,3]);

Pass an array (ref) for a 1D iDCT-II calculation. The output will be an arrayref with the result of the transform. This is essentially a DCT-III transform scaled by 2/N.

dct2d

  my $dct = dct2d(
      [1,2,3,4],   # Arrayref containing your NxN matrix
      2            # Optionally, the size N of your array (sqrt of its length)
  );

Pass an array (ref) for a 2D DCT-II calculation. The length of the array is expected to be a square (as only NxN arrays are supported) - you can optionally pass N as the second argument to avoid a sqrt calculation. The output will be an arrayref with the result of the transform.

If your 2D data is available in a 1D array as is usual with most image manipulation etc cases, this function will be faster than dct, as the DCT calculation is in any case done on a 1D array, hence you save the cost of conversion.

idct2d

  my $idct = idct2d(
      [1,2,3,4],   # Arrayref containing your NxN matrix
      2            # Optionally, the size N of your array (sqrt of its length)
  );

Pass an array (ref) for a 2D iDCT-II calculation. The length of the array is expected to be a square (as only NxN arrays are supported) - you can optionally pass N as the second argument to avoid a sqrt calculation. This is essentially a DCT-III transform scaled by 2/N. The output will be an arrayref with the result of the transform.

USAGE NOTES

The C functions are not exported, but theoretically you could use them directly if you do your own pack/unpack. The fast versions for power-of-2 size arrays are fast_dct_1d and fast_dct_2d, while the generic versions are dct_1d and dct_2d (with inverse functions as idct_1d and idct_2d). The specialized size-8 versions are fct8_1d and fct8_2d. First argument is a char * (use pack "dN"), second is the size N (except for the fct8* functions which don't need a second argument).

ACKNOWLEDGEMENTS

C code for 1D DCT from Project Nayuki was adapted and improved where possible.

(https://www.nayuki.io/page/fast-discrete-cosine-transform-algorithms)

AUTHOR

Dimitrios Kechagias, <dkechag at cpan.org>

BUGS

Please report any bugs or feature requests to bug-math-dct at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Math-DCT. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

GIT

https://github.com/SpareRoom/Math-DCT

COPYRIGHT & LICENSE

Copyright (C) 2019, SpareRoom.com

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.