1 package Audio
::Opusfile
;
8 use parent qw
/Exporter/;
12 qw
/OPUS_CHANNEL_COUNT_MAX
31 OP_GET_SERVER_INFO_REQUEST
34 OP_HTTP_PROXY_HOST_REQUEST
35 OP_HTTP_PROXY_PASS_REQUEST
36 OP_HTTP_PROXY_PORT_REQUEST
37 OP_HTTP_PROXY_USER_REQUEST
43 OP_SSL_SKIP_CERTIFICATE_CHECK_REQUEST
46 our @EXPORT_OK = @constants;
47 our @EXPORT = @constants;
49 our $VERSION = '0.003';
52 # This AUTOLOAD is used to 'autoload' constants from the constant()
57 ($constname = $AUTOLOAD) =~ s/.*:://;
58 croak
"&Audio::Opusfile::constant not defined" if $constname eq 'constant';
59 my ($error, $val) = constant
($constname);
60 if ($error) { croak
$error; }
63 # Fixed between 5.005_53 and 5.005_61
64 #XXX if ($] >= 5.00561) {
65 #XXX *$AUTOLOAD = sub () { $val };
68 *$AUTOLOAD = sub { $val };
75 XSLoader
::load
('Audio::Opusfile', $VERSION);
76 require Audio
::Opusfile
::Head
;
77 require Audio
::Opusfile
::Tags
;
78 require Audio
::Opusfile
::PictureTag
;
80 # Preloaded methods go here.
83 my ($class, $file) = @_;
88 my ($class, $buf) = @_;
99 Audio::Opusfile - Very incomplete interface to the libopusfile Ogg Opus library
104 my $of = Audio::Opusfile->new_from_file('silence.opus');
105 my $tags = $of->tags;
106 say $tags->query('TITLE'); # Cellule
110 Opus is a totally open, royalty-free, highly versatile audio codec.
111 Opus is unmatched for interactive speech and music transmission over
112 the Internet, but is also intended for storage and streaming
113 applications. It is standardized by the Internet Engineering Task
114 Force (IETF) as RFC 6716 which incorporated technology from Skype's
115 SILK codec and Xiph.Org's CELT codec.
117 libopusfile is a library for decoding and basic manipulation of Ogg
120 Audio::Opusfile is an interface to libopusfile. At the moment its only
121 function is reading metadata and tags from an Ogg Opus file or buffer.
122 Future versions will give access to a larger part of the libopusfile
125 Expect the API to change in future versions.
131 =item Audio::Opusfile->B<new_from_file>(I<$file>)
133 Creates a new Audio::Opusfile object from an Ogg Opus file.
135 Dies if the given file does not exist or is not a valid Ogg Opus file.
137 =item Audio::Opusfile->B<new_from_memory>(I<$buffer>)
139 Creates a new Audio::Opusfile object from a buffer containing Ogg Opus
142 Dies if the given buffer does not contain valid data.
144 =item Audio::Opusfile::test(I<$buffer>)
146 Returns true if the given buffer looks like the beginning of a valid
147 Ogg Opus file, false otherwise.
149 Dies if the given buffer does not have sufficient data to tell if it
150 is an Opus stream or if it looks like a Opus stream but parsing it
155 Returns an L<Audio::Opusfile::Head> object corresponding to the file.
159 Returns an L<Audio::Opusfile::Tags> object corresponding to the file.
161 =item B<$of>->seekable
163 Returns whether or not the data source being read is seekable.
165 =item B<$of>->link_count
167 Returns the number of links in this chained stream. Always returns 1
168 for unseekable sources.
170 =item B<$of>->serialno([I<$link_index>])
172 Get the serial number of the given link in a (possibly-chained) Ogg
173 Opus stream. If the given index is greater than the total number of
174 links, this returns the serial number of the last link.
176 If the source is not seekable, I<$link_index> is negative, or
177 I<$link_index> is not given, then this function returns the serial
178 number of the current link.
180 =item B<$of>->op_raw_total([I<$link_index>])
182 Get the total (compressed) size of the stream (with no arguments), or
183 of an individual link in a (possibly-chained) Ogg Opus stream (with
184 one nonnegative argument), including all headers and Ogg muxing
187 The stream must be seekable to get the total. A negative value is
188 returned if the stream is not seekable.
190 B<Warning:> If the Opus stream (or link) is concurrently multiplexed
191 with other logical streams (e.g., video), this returns the size of the
192 entire stream (or link), not just the number of bytes in the first
193 logical Opus stream. Returning the latter would require scanning the
196 =item B<$of>->op_pcm_total([I<$link_index>])
198 Get the total PCM length (number of samples at 48 kHz) of the stream
199 (with no arguments), or of an individual link in a (possibly-chained)
200 Ogg Opus stream (with one nonnegative argument).
202 Users looking for op_time_total() should use this function instead.
203 Because timestamps in Opus are fixed at 48 kHz, there is no need for a
204 separate function to convert this to seconds.
206 The stream must be seekable to get the total. A negative value is
207 returned if the stream is not seekable.
209 =item B<$of>->op_bitrate([I<$link_index>])
211 Computes the bitrate of the stream (with no arguments), or of an
212 individual link in a (possibly-chained) Ogg Opus stream (with one
213 nonnegative argument).
215 The stream must be seekable to compute the bitrate. A negative value
216 is returned if the stream is not seekable.
218 B<Warning:> If the Opus stream (or link) is concurrently multiplexed with
219 other logical streams (e.g., video), this uses the size of the entire
220 stream (or link) to compute the bitrate, not just the number of bytes
221 in the first logical Opus stream.
227 All constants are exported by default:
229 OPUS_CHANNEL_COUNT_MAX
248 OP_GET_SERVER_INFO_REQUEST
251 OP_HTTP_PROXY_HOST_REQUEST
252 OP_HTTP_PROXY_PASS_REQUEST
253 OP_HTTP_PROXY_PORT_REQUEST
254 OP_HTTP_PROXY_USER_REQUEST
258 OP_PIC_FORMAT_UNKNOWN
260 OP_SSL_SKIP_CERTIFICATE_CHECK_REQUEST
266 L<Audio::Opusfile::Head>,
267 L<Audio::Opusfile::Tags>,
268 L<http://opus-codec.org/>,
269 L<http://opus-codec.org/docs/opusfile_api-0.7/index.html>
273 Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
275 =head1 COPYRIGHT AND LICENSE
277 Copyright (C) 2016 by Marius Gavrilescu
279 This library is free software; you can redistribute it and/or modify
280 it under the same terms as Perl itself, either Perl version 5.24.0 or,
281 at your option, any later version of Perl 5 you may have available.