NAME

TagLib::Ogg::Page - An implementation of Ogg pages

SYNOPSIS

  use TagLib::Ogg::Page;
  
  my $i    = TagLib::Ogg::Page->new($file, $pageOffset);
  my $data = $i->render();

DESCRIPTION

This is an implementation of the pages that make up an Ogg stream. This handles parsing pages and breaking them down into packets and handles the details of packets spanning multiple pages and pages that contiain multiple packets.

In most Xiph.org formats the comments are found in the first few packets, this however is a reasonably complete implementation of Ogg pages that could potentially be useful for non-meta data purposes.

new(PV $file, IV $pageOffset)

Read an Ogg page from the $file at the position $pageOffset.

DESTROY()

Destroys the instance of Page.

IV fileOffset()

Returns the page's position within the file (in bytes).

PageHeader header()

Returns the header for this page. This will become invalid when the page is delete.

IV firstPacketIndex()

Returns the index of the first packet wholly or partially contained in this page.

see setFirstPacketIndex()

void setFirstPacketIndex(IV $index)

Sets the index of the first packet in the page.

see firstPacketIndex()

%_ContainsPacketFlags

When checking to see if a page contains a given packet this set of flags represents the possible values for that packets status in the page.

see containsPacket()

PV containsPacket($index)

Checks to see if the specified packet is contained in the current page.

see %_ContainsPacketFlags

UV packetCount()

Returns the number of packets (whole or partial) in this page.

ByteVectorList packets()

Returns a list of the packets in this page.

NOTE Either or both the first and last packets may be only partial.

see PageHeader::firstPacketContinued()|TagLib::Ogg::PageHeader

IV size()

Returns the size of the page in bytes.

ByteVector render()

Renders the page to binary format.

%_PaginationStrategy

Defines a strategy for pagination, or grouping pages into Ogg packets, for use with pagination methods.

NOTE Yes, I'm aware that this is not a canonical "Strategy Pattern", the term was simply convenient.

LIST paginate(ByteVector $packets, PV $strategy, UV $streamSerialNumber, IV $firstPage, BOOL $firstPacketContinued = FALSE, BOOL $lastPacketCompleted = TRUE, BOOL $containsLastPacket = FALSE) [static]

Packs $packets into Ogg pages using the $strategy for pagination. The page number indicater inside of the rendered packets will start with $firstPage and be incremented for each page rendered. $containsLastPacket should be set to true if $packets contains the last page in the stream and will set the appropriate flag in the last rendered Ogg page's header. $streamSerialNumber should be set to the serial number for this stream.

NOTE The "absolute granule position" is currently always zeroed using this method as this suffices for the comment headers.

This returns a list of all the pages.

see %_PaginationStrategy

EXPORT

None by default.

SEE ALSO

TagLib

AUTHOR

Dongxu Ma, <dongxu.ma@gmail.com>

COPYRIGHT AND LICENSE

Copyright (C) 2005 by Dongxu Ma

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