Bump version and update Changes

[io-compress-brotli.git] / lib / IO / Uncompress / Brotli.pm

package IO::Uncompress::Brotli;

use 5.014000;
use strict;
use warnings;
use parent qw/Exporter/;

our @EXPORT = qw/unbro/;
our @EXPORT_OK = @EXPORT;

our $VERSION = '0.001001';

require XSLoader;
XSLoader::load('IO::Compress::Brotli', $VERSION);

sub create {
	my ($class) = @_;
	my $state = BrotliCreateState();
	bless \$state, $class
}

sub DESTROY {
	my ($self) = @_;
	BrotliDestroyState($$self)
}

sub decompress {
	my ($self, $data) = @_;
	BrotliDecompressStream($$self, $data)
}

# Untested, probably not working
sub set_dictionary {
	my ($self, $dict) = @_;
	BrotliSetCustomDictionary($$self, $dict)
}

1;
__END__

=encoding utf-8

=head1 NAME

IO::Uncompress::Brotli - Read Brotli buffers/streams

=head1 SYNOPSIS

  use IO::Uncompress::Brotli;

  # uncompress a buffer
  my $decoded = unbro $encoded;

  # uncompress a stream
  my $bro = IO::Uncompress::Brotli->create;
  while(have_input()) {
     my $block = get_input_block();
     my $decoded_block = $bro->decompress($block);
     handle_output_block($decoded_block);
  }

=head1 DESCRIPTION

IO::Uncompress::Brotli is a module that decompresses Brotli buffers
and streams. Despite its name, it is not a subclass of
L<IO::Uncompress::Base> and does not implement its interface. This
will be rectified in a future release.

=head2 One-shot interface

If you have the whole buffer in a Perl scalar use the B<unbro>
function.

=over

=item B<unbro>(I<$input>)

Takes a whole compressed buffer as input and returns the decompressed
data. This function relies on the BrotliDecompressedSize function. In
other words, it only works if the buffer has a single meta block or
two meta-blocks where the first is uncompressed and the second is
empty.

Exported by default.

=back

=head2 Streaming interface

If you want to process the data in blocks use the object oriented
interface. The available methods are:

=over

=item IO::Uncompress::Brotli->B<create>

Returns a IO::Uncompress::Brotli instance. Please note that a single
instance cannot be used to decompress multiple streams.

=item $bro->B<decompress>(I<$block>)

Takes the a block of compressed data and returns a block of
uncompressed data. Dies on error.

=back

=head1 SEE ALSO

Brotli Compressed Data Format Internet-Draft:
L<https://www.ietf.org/id/draft-alakuijala-brotli-08.txt>

Brotli source code: L<https://github.com/google/brotli/>

=head1 AUTHOR

Marius Gavrilescu, E<lt>marius@ieval.roE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2015 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.20.2 or,
at your option, any later version of Perl 5 you may have available.


=cut