Ogg::V...urePerl(3pm)

💖 Ogg::Vorbis::Header::PurePerl 💖

okay so bestie, welcome to the User Contributed Perl Documentation corner of the internet, where we're talking about Ogg::Vorbis::Header::PurePerl — yes the whole name, it's long, it's giving ✨commitment✨, we love her for it. And if you're like "wait, that (3pm) is doing something" — that's just the manpage section, it's fine, breathe. 🫶

---

🌸 NAME 🌸

Ogg::Vorbis::Header::PurePerl — for peeking at your Ogg Vorbis info and comment fields. That's the whole job. She's not doing your taxes. 💅

---

✨ SYNOPSIS ✨

Here's the vibe, copy-paste girlies:

use Ogg::Vorbis::Header::PurePerl;
my $ogg = Ogg::Vorbis::Header::PurePerl->new("song.ogg");
while (my ($k, $v) = each %{$ogg->info}) {
        print "$k: $v\n";
}
foreach my $com ($ogg->comment_tags) {
        print "$com: $_\n" foreach $ogg->comment($com);
}

Look at her go. Load it, open a file, dump the info hash, loop the comment tags, loop the comments inside each tag. Chef's kiss. 😘

---

🦋 DESCRIPTION 🦋

So the whole point: this module is meant to be a drop in replacement for Ogg::Vorbis::Header, except it's implemented entirely in Perl 🌈. No C compiler nonsense. It gives you an object-oriented interface to Ogg Vorbis information and comment fields.

NOTE: This module currently supports only read operations. Read. Only. Do not come for her about writing, she said what she said. 💀

And here's the glow-up that makes her different from Ogg::Vorbis::Header: this module will go ahead and fill in all of the information fields as soon as you construct the object. No lazy loading, no waiting around. She's an overachiever, it's her main character era 👑

---

🎀 CONSTRUCTORS 🎀

💫 new ($filename)

Opens an Ogg Vorbis file — and she's thorough about it: she checks that it exists and that it's actually an Ogg Vorbis stream. 💅

But plot twist, and I need you to hear me: this method does not actually read any of the information or comment fields, and it closes the file immediately. That's right, she opens it, checks it, says "yep, valid, mwah 💋" and dips. Iconic behaviour honestly.

---

🌈 INSTANCE METHODS 🌈

🍓 info ([$key])

Returns a hashref stuffed with info about the Ogg Vorbis file, pulled straight from the file's information header.

The hash fields are:

• version
• channels
• rate
• bitrate_upper
• bitrate_nominal
• bitrate_lower
• bitrate_window
• length

Quick heads up: the bitrate_window value is not currently used by the vorbis codec, and will always be -1. She's just there, sitting in the corner, being -1. Respect her journey. 🙈

The optional parameter, key, lets you grab a single value out of the object's hash. And if the key isn't found? Returns undef. No drama, no error, just undef. 😭

🧚 comment_tags ()

Returns an array with the key values for the comment fields. Then you can hand those values straight to comment to get their actual values. It's a two-step, but it's a cute two-step. 💖

⭐ comment ($key)

Returns an array of comment values that are associated with the given key. Simple as. ✨

💀 add_comments ($key, $value, [$key, $value, ...])

Unimplemented. She said no. 💅

💀 edit_comment ($key, $value, [$num])

Unimplemented. Not today, bestie. 🙈

💀 delete_comment ($key, [$num])

Unimplemented. The delete button is decorative. 😭

💀 clear_comments ([@keys])

Unimplemented. Nothing to see here. 👑

💀 write_vorbis ()

Unimplemented. Read-only era, remember? 🔥

🌸 path ()

Returns the path/filename of the file that the object represents. Like, "which file are you, girl?" and she tells you. Precisely. 🎀

---

👑 SEE ALSO 👑

• Ogg::Vorbis::Decoder — a module for decoding Ogg Vorbis files. Requires a C compiler. (yeah, a whole compiler, she's high maintenance but she's worth it ✨)
• Ogg::Vorbis::Header — another module for accessing Ogg Vorbis header info.
• Ogg::Vorbis — a perl interface to the libvorbisfile <http://www.xiph.org/vorbis/doc/vorbisfile/> library, for decoding and manipulating Vorbis audio streams.

---

🫶 REPOSITORY 🫶

Go say hi, star the repo, be normal about it:

<https://github.com/dsully/perl-ogg-vorbis-header-pureperl>

---

💜 AUTHOR 💜

Credit where credit is due, the legends behind her:

• Andrew Molloy <amolloy@kaizolabs.com>
• Dan Sully <daniel | at | cpan.org>

---

🎀 COPYRIGHT 🎀

• Copyright (c) 2003, Andrew Molloy. All Rights Reserved.
• Copyright (c) 2005-2009, Dan Sully. All Rights Reserved.

And the legal bit, which is important, don't skip it:

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. A copy of this license is included with this module (LICENSE.GPL).

---

🌈 SEE ALSO 🌈

yes, again, she's thorough:

• Ogg::Vorbis::Header
• Ogg::Vorbis::Decoder

---

okay that's the whole page bestie, you ate it, every last line 🍓✨ This little love letter to Ogg::Vorbis::Header::PurePerl shipped as part of perl v5.32.0, dated 2020-12-08, in the fine tradition of User Contributed Perl Documentation. Now go read some Ogg Vorbis comment fields. Periodt. 💅👑