[7911] | 1 | ###########################################################################
|
---|
| 2 | #
|
---|
| 3 | # OggVorbisPlug.pm -- A plugin for Ogg Vorbis audio files
|
---|
| 4 | #
|
---|
| 5 | # Original code by Christy Kuo
|
---|
| 6 | #
|
---|
| 7 | # A component of the Greenstone digital library software
|
---|
| 8 | # from the New Zealand Digital Library Project at the
|
---|
| 9 | # University of Waikato, New Zealand.
|
---|
| 10 | #
|
---|
| 11 | # Copyright 1999-2004 New Zealand Digital Library Project
|
---|
| 12 | #
|
---|
| 13 | # This program is free software; you can redistribute it and/or modify
|
---|
| 14 | # it under the terms of the GNU General Public License as published by
|
---|
| 15 | # the Free Software Foundation; either version 2 of the License, or
|
---|
| 16 | # (at your option) any later version.
|
---|
| 17 | #
|
---|
| 18 | # This program is distributed in the hope that it will be useful,
|
---|
| 19 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 20 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 21 | # GNU General Public License for more details.
|
---|
| 22 | #
|
---|
| 23 | # You should have received a copy of the GNU General Public License
|
---|
| 24 | # along with this program; if not, write to the Free Software
|
---|
| 25 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
| 26 | #
|
---|
| 27 | ###########################################################################
|
---|
| 28 |
|
---|
[15872] | 29 | package OggVorbisPlugin;
|
---|
[7911] | 30 |
|
---|
| 31 |
|
---|
[15872] | 32 | use BasePlugin;
|
---|
[7911] | 33 | use Ogg::Vorbis::Header::PurePerl;
|
---|
| 34 |
|
---|
[10254] | 35 | use strict;
|
---|
| 36 | no strict 'refs'; # allow filehandles to be variables and viceversa
|
---|
[15872] | 37 | no strict 'subs';
|
---|
[7911] | 38 |
|
---|
| 39 | sub BEGIN {
|
---|
[15872] | 40 | @OggVorbisPlugin::ISA = ('BasePlugin');
|
---|
[7911] | 41 | }
|
---|
| 42 |
|
---|
| 43 |
|
---|
| 44 | my $arguments =
|
---|
| 45 | [ { 'name' => "process_exp",
|
---|
[15872] | 46 | 'desc' => "{BasePlugin.process_exp}",
|
---|
[7911] | 47 | 'type' => "string",
|
---|
| 48 | 'deft' => &get_default_process_exp(),
|
---|
| 49 | 'reqd' => "no" },
|
---|
| 50 | { 'name' => "add_technical_metadata",
|
---|
[15872] | 51 | 'desc' => "{OggVorbisPlugin.add_technical_metadata}",
|
---|
[7911] | 52 | 'type' => "flag",
|
---|
| 53 | 'deft' => "" } ];
|
---|
| 54 |
|
---|
[15872] | 55 | my $options = { 'name' => "OggVorbisPlugin",
|
---|
| 56 | 'desc' => "{OggVorbisPlugin.desc}",
|
---|
[7911] | 57 | 'inherits' => "yes",
|
---|
[11676] | 58 | 'abstract' => "no",
|
---|
[7911] | 59 | 'args' => $arguments };
|
---|
| 60 |
|
---|
| 61 |
|
---|
| 62 | # This plugin processes exported Ogg Vorbis files with the suffix ".ogg"
|
---|
| 63 | sub get_default_process_exp
|
---|
| 64 | {
|
---|
| 65 | return q^(?i)(\.ogg)$^;
|
---|
| 66 | }
|
---|
| 67 |
|
---|
| 68 |
|
---|
| 69 | sub new
|
---|
| 70 | {
|
---|
[10218] | 71 | my ($class) = shift(@_);
|
---|
| 72 | my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
|
---|
| 73 | push(@$pluginlist, $class);
|
---|
| 74 |
|
---|
[15872] | 75 | push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
|
---|
| 76 | push(@{$hashArgOptLists->{"OptList"}},$options);
|
---|
[10218] | 77 |
|
---|
[15872] | 78 | my $self = new BasePlugin($pluginlist, $inputargs, $hashArgOptLists);
|
---|
[10218] | 79 |
|
---|
[7911] | 80 | return bless $self, $class;
|
---|
| 81 | }
|
---|
| 82 |
|
---|
[15872] | 83 | sub process
|
---|
[7911] | 84 | {
|
---|
| 85 | my $self = shift (@_);
|
---|
[15872] | 86 | my ($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
|
---|
[7911] | 87 |
|
---|
[16392] | 88 | my ($filename_full_path, $filename_no_path) = &util::get_full_filenames($base_dir, $file);
|
---|
[15872] | 89 | # do something about OIDtype so no hashing
|
---|
| 90 |
|
---|
| 91 | # old code was in effect the following.
|
---|
| 92 | if ($doc_obj->{'OIDtype'} =~ /^hash$/) {
|
---|
| 93 | $doc_obj->set_OIDtype ("incremental");
|
---|
[12270] | 94 | }
|
---|
[13543] | 95 |
|
---|
[15872] | 96 | my $top_section = $doc_obj->get_top_section();
|
---|
[7911] | 97 | # Extract metadata
|
---|
[15872] | 98 | my $ogg = Ogg::Vorbis::Header::PurePerl->new($filename_full_path);
|
---|
[7911] | 99 |
|
---|
| 100 | # Comments added to the file
|
---|
| 101 | foreach my $key ($ogg->comment_tags())
|
---|
| 102 | {
|
---|
| 103 | # Convert key to title case
|
---|
| 104 | my $keytc = uc(substr($key, 0, 1)) . substr($key, 1, length($key));
|
---|
| 105 | foreach my $value ($ogg->comment($key))
|
---|
| 106 | {
|
---|
| 107 | if (defined $value && $value ne "") {
|
---|
[15872] | 108 | $doc_obj->add_metadata($top_section, $keytc, $value);
|
---|
[7911] | 109 | }
|
---|
| 110 | }
|
---|
| 111 | }
|
---|
| 112 |
|
---|
| 113 | # Technical data (optional)
|
---|
| 114 | if ($self->{'add_technical_metadata'}) {
|
---|
| 115 | foreach my $key (keys %{$ogg->info})
|
---|
| 116 | {
|
---|
| 117 | # Convert key to title case
|
---|
| 118 | my $keytc = uc(substr($key, 0, 1)) . substr($key, 1, length($key));
|
---|
| 119 | my $value = $ogg->info->{$key};
|
---|
| 120 | if (defined $value && $value ne "") {
|
---|
[15872] | 121 | $doc_obj->add_metadata($top_section, $keytc, $value);
|
---|
[7911] | 122 | }
|
---|
| 123 | }
|
---|
| 124 | }
|
---|
| 125 |
|
---|
[15872] | 126 | $doc_obj->add_metadata ($top_section, "FileFormat", "OggVorbis");
|
---|
| 127 | $doc_obj->add_metadata ($top_section, "srclink", "<a href=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Source]\">");
|
---|
| 128 | $doc_obj->add_metadata ($top_section, "/srclink", "</a>");
|
---|
[11193] | 129 | # srcicon (need to include "iogg.gif" in the greenstone images directory
|
---|
[15872] | 130 | $doc_obj->add_metadata ($top_section, "srcicon", "<img src=\"_httpprefix_/images/iogg.gif\" title=\"Download\" border=0>");
|
---|
[7911] | 131 |
|
---|
[15911] | 132 | # add dummy text and NoText metadata which can be used to suppress the dummy text
|
---|
| 133 | $self->add_dummy_text($doc_obj, $top_section);
|
---|
[14117] | 134 |
|
---|
[7911] | 135 | # Add the actual file as an associated file
|
---|
[15872] | 136 | $doc_obj->associate_file($filename_full_path, $filename_no_path, "VORBIS", $top_section);
|
---|
[7911] | 137 |
|
---|
| 138 | }
|
---|
| 139 |
|
---|
| 140 |
|
---|
| 141 | 1;
|
---|