source: gs2-extensions/video-and-audio/trunk/src/perllib/plugins/MultimediaPlugin.pm@ 26920

Last change on this file since 26920 was 26920, checked in by jmt12, 11 years ago

making ffmpeg detection tests a little more robust due to version changes

File size: 9.1 KB
Line 
1######################################################################
2#
3# MultimediaPlugin.pm -- internal plugin to support processing audio and video
4# A component of the Greenstone digital library software
5# from the New Zealand Digital Library Project at the
6# University of Waikato, New Zealand.
7#
8# Copyright (C) 1999 New Zealand Digital Library Project
9#
10# This program is free software; you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 2 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program; if not, write to the Free Software
22# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23#
24###########################################################################
25
26# -- Largely modeled on how ImagePlugin works
27
28package MultimediaPlugin;
29
30use strict;
31no strict 'refs'; # allow filehandles to be variables and viceversa
32no strict 'subs';
33
34use gsprintf;
35
36use BasePlugin;
37
38sub BEGIN {
39 @MultimediaPlugin::ISA = ('BasePlugin');
40
41 if (!defined $ENV{'GEXTVIDEO'}) {
42 print STDERR "Warning: Greenstone Video extension not detected.\n";
43 }
44
45}
46
47
48
49 # do later the description
50my $arguments =
51 [ { 'name' => "use_ascii_only_filenames",
52 'desc' => "{VideoPlug.use_ascii_only_filenames}",
53 'type' => "flag",
54 'reqd' => "no" },
55 { 'name' => "excerpt_duration",
56 'desc' => "{MultimediaPlug.excerpt_duration}",
57 'type' => "string",
58 'deft' => "",
59 'reqd' => "no" },
60 { 'name' => "converttotype",
61 'desc' => "{MultimediaPlug.converttotype}",
62 'type' => "string",
63 'deft' => "",
64 'reqd' => "no" },
65 { 'name' => "enable_streaming",
66 'desc' => "{MultimediaPlug.enable_streaming}",
67 'type' => "enum",
68 'list' => [{'name' => "disabled", 'desc' => "Do not create any video file optimised for streaming over the Internet."},
69 {'name' => "flv", 'desc' => "Uses the FLV format for streaming media. Better to target old computers."},
70 {'name' => "mp4", 'desc' => "Uses the MP4 container with H264 and AAC codecs. Better quality at very low bitrates but more ressources intensive."},
71 {'name' => "direct", 'desc' => "Uses the original video file for direct streaming. The video player should be compatible with the format used!"}],
72 'deft' => "disabled",
73 'reqd' => "no" }];
74
75my $options = { 'name' => "MultimediaPlugin",
76 'desc' => "{MultimediaPlug.desc}",
77 'abstract' => "yes",
78 'inherits' => "yes",
79 'args' => $arguments };
80
81
82sub new {
83 my ($class) = shift (@_);
84 my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
85 push(@$pluginlist, $class);
86
87 push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
88 push(@{$hashArgOptLists->{"OptList"}},$options);
89
90 my $self = new BasePlugin($pluginlist, $inputargs, $hashArgOptLists);
91
92 # Check that ffmpeg is installed and available on the path (except for Windows 95/98)
93 # This test is "inherited" from ImagePlugin where ImageMagick support
94 # for building cannot be used on these two versions of Windows as they
95 # do not have enough flexablity in the use of stdout and stderr to
96 # support how our code works. It seems reasonable to assume the
97 # same is true for MultimediaPlugin work using ffmpeg.
98
99 if (($ENV{'GSDLOS'} ne "windows" || Win32::IsWinNT())) {
100
101 my $result = `ffmpeg -version 2>&1`;
102
103 if (!defined $result || $result !~ m/^FFmpeg version/im) {
104 $self->{'ffmpeg_installed'} = 0;
105 if (defined $result) {
106 print STDERR $result;
107 }
108 else {
109 print STDERR "Unable to find ffmpeg\n";
110 }
111 }
112 else {
113 $self->{'ffmpeg_installed'} = 1;
114 }
115
116 }
117
118 return bless $self, $class;
119}
120
121
122
123sub begin {
124 my $self = shift (@_);
125 my ($pluginfo, $base_dir, $processor, $maxdocs) = @_;
126
127 $self->SUPER::begin(@_);
128
129 $self->{'base_dir'} = $base_dir;
130}
131
132
133sub init {
134 my $self = shift (@_);
135 my ($verbosity, $outhandle, $failhandle) = @_;
136
137 $self->SUPER::init(@_);
138}
139
140# Want to hash on doc.xml rather than original file which in the case of
141# audio and video can be HUGE
142
143sub get_oid_hash_type {
144
145 my $self = shift (@_);
146
147 return "hash_on_ga_xml";
148}
149
150
151
152# Create the keyframes, thumbnail and screenview images, and discover
153# the Video's size, width, and height using the ffmpeg utility.
154
155sub run_convert {
156 my $self = shift (@_);
157
158 die "$self The inheriting class must implement run_convert method";
159}
160
161
162sub read_into_doc_obj {
163 my $self = shift (@_);
164 my ($pluginfo, $base_dir, $file, $block_hash, $metadata, $processor, $maxdocs, $total_count, $gli) = @_;
165
166 my $outhandle = $self->{'outhandle'};
167
168 # should we move this to read? What about secondary plugins?
169 print STDERR "<Processing n='$file' p='$self->{'plugin_type'}'>\n" if ($gli);
170 print $outhandle "$self->{'plugin_type'} processing $file\n"
171 if $self->{'verbosity'} > 1;
172
173 my ($filename_full_path, $filename_no_path) = &util::get_full_filenames($base_dir, $file);
174
175 # create a new document
176 my $doc_obj = new doc ($filename_full_path, "indexed_doc", $self->{'file_rename_method'});
177
178
179 my $top_section = $doc_obj->get_top_section();
180
181
182 $doc_obj->add_utf8_metadata($top_section, "Plugin", "$self->{'plugin_type'}");
183 $doc_obj->add_utf8_metadata($top_section, "FileSize", (-s $filename_full_path));
184
185 # sets the UTF8 filename (Source) for display and sets the url ref to URL encoded version
186 # of the UTF8 filename (SourceFile) for generated files
187 $self->set_Source_metadata($doc_obj, $filename_no_path);
188
189
190 # plugin specific stuff - what args do we need here??
191 unless (defined ($self->process($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli))) {
192 print STDERR "<ProcessingError n='$file'>\n" if ($gli);
193 return (-1,undef);
194 }
195
196 # include any metadata passed in from previous plugins
197 # note that this metadata is associated with the top level section
198 my $section = $doc_obj->get_top_section();
199 # can we merge these two methods??
200 $self->add_associated_files($doc_obj, $filename_full_path);
201 $self->extra_metadata ($doc_obj, $section, $metadata);
202 $self->auto_extract_metadata($doc_obj);
203
204 # if we haven't found any Title so far, assign one
205 # this was shifted to here from inside read()
206 $self->title_fallback($doc_obj,$section,$filename_no_path);
207
208 $self->add_OID($doc_obj);
209
210 $self->post_process_doc_obj($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli);
211
212 return (1,$doc_obj);
213}
214
215sub add_dummy_text {
216 my $self = shift(@_);
217 my ($doc_obj, $section) = @_;
218
219 # add NoText metadata so we can hide this dummy text in format statements
220 $doc_obj->add_metadata($section, "NoText", "1");
221 $doc_obj->add_text($section, &gsprintf::lookup_string("{BasePlugin.dummy_text}",1));
222
223}
224
225
226
227
228# do plugin specific processing of doc_obj
229sub process {
230 my $self = shift (@_);
231 # options??
232 my ($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
233
234 my $outhandle = $self->{'outhandle'};
235
236 my ($filename_full_path, $filename_no_path) = &util::get_full_filenames($base_dir, $file);
237
238
239 if ($self->{'ffmpeg_installed'}) {
240 my $utf8_filename_no_path = $self->filepath_to_utf8($filename_no_path);
241 my $url_encoded_filename = &util::rename_file($utf8_filename_no_path, $self->{'file_rename_method'});
242
243
244 #run convert to get the thumbnail and extract size and type info
245 my $result = $self->run_convert($base_dir, $filename_full_path,
246 $url_encoded_filename, $doc_obj);
247
248 if (!defined $result) {
249 if ($gli) {
250 print STDERR "<ProcessingError n='$file'>\n";
251 }
252 print $outhandle "MultimediaPlugin: couldn't process \"$filename_full_path\"\n";
253 return (-1,undef); # error during processing
254 }
255 }
256 else {
257 if ($gli) {
258 &gsprintf(STDERR, "<Warning p='MultimediaPlugin' r='{MultimediaConverter.noconversionavailable}: {MultimediaConverter.".$self->{'no_multimedia_conversion_reason'}."}'>");
259 }
260 # all we do is add the original video file as an associated file, and set up srclink etc
261 my $assoc_file = $doc_obj->get_assocfile_from_sourcefile();
262 my $section = $doc_obj->get_top_section();
263
264 $doc_obj->associate_file($filename_full_path, $assoc_file, "", $section);
265
266 $doc_obj->add_metadata ($section, "srclink", "<a href=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[SourceFile]\">");
267 $doc_obj->add_metadata ($section, "/srclink", "</a>");
268 $doc_obj->add_metadata ($section, "srcicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[SourceFile]\" width=\"100\">");
269
270 }
271 #we have no text - adds dummy text and NoText metadata
272 $self->add_dummy_text($doc_obj, $doc_obj->get_top_section());
273
274 return 1;
275
276}
277
278
279
2801;
281
282
283
284
285
286
287
288
289
290
291
Note: See TracBrowser for help on using the repository browser.