source: gs2-extensions/video/trunk/perllib/plugins/VideoPlugin.pm@ 22432

Last change on this file since 22432 was 22432, checked in by davidb, 14 years ago

Adjustment of calling BaseMediaConverter to pass in additional input file parameter
File size: 30.9 KB
Line 
1######################################################################
2#
3# VideoPlugin.pm -- plugin for processing video files
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# -- Can convert to audio as well as video
28
29package VideoPlugin;
30
31use strict;
32no strict 'refs'; # allow filehandles to be variables and viceversa
33no strict 'subs';
34
35use XMLParser;
36use gsprintf;
37
38use MultimediaPlugin;
39use VideoConverter;
40use ReadXMLFile;
41
42sub BEGIN {
43 @VideoPlugin::ISA = ('MultimediaPlugin', 'VideoConverter', 'ReadXMLFile');
44}
45
46
47my $arguments =
48 [ { 'name' => "process_exp",
49 'desc' => "{BasePlugin.process_exp}",
50 'type' => "regexp",
51 'deft' => &get_default_process_exp(),
52 'reqd' => "no" } ];
53
54
55my $options = { 'name' => "VideoPlugin",
56 'desc' => "{VideoPlugin.desc}",
57 'abstract' => "no",
58 'inherits' => "yes",
59 'args' => $arguments };
60
61sub new {
62 my ($class) = shift (@_);
63 my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
64 push(@$pluginlist, $class);
65
66 push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
67 push(@{$hashArgOptLists->{"OptList"}},$options);
68
69 new VideoConverter($pluginlist, $inputargs, $hashArgOptLists);
70 my $self = new MultimediaPlugin($pluginlist, $inputargs, $hashArgOptLists);
71
72 if ($self->{'info_only'}) {
73 # don't worry about creating the XML parser as all we want is the
74 # list of plugin options
75 return bless $self, $class;
76 }
77
78
79 # create XML::Parser object for parsing keyframe files (produced by hive)
80 my $parser = new XML::Parser('Style' => 'Stream',
81 'Pkg' => 'VideoPlugin',
82 'PluginObj' => $self,
83 'Namespaces' => 1, # strip out namespaces
84 'Handlers' => {'Char' => \&Char,
85 'XMLDecl' => \&XMLDecl,
86 'Entity' => \&Entity,
87 'Doctype' => \&Doctype,
88 'Default' => \&Default
89 });
90
91 $self->{'parser'} = $parser;
92
93
94 return bless $self, $class;
95}
96
97
98
99sub begin {
100 my $self = shift (@_);
101 my ($pluginfo, $base_dir, $processor, $maxdocs) = @_;
102
103 $self->SUPER::begin(@_);
104 $self->VideoConverter::begin(@_);
105}
106
107
108sub init {
109 my $self = shift (@_);
110 my ($verbosity, $outhandle, $failhandle) = @_;
111
112 $self->SUPER::init(@_);
113 $self->VideoConverter::init(@_);
114}
115
116
117sub get_default_process_exp {
118 my $self = shift (@_);
119
120 return q^(?i)\.(mpe?g|flv|mov|qt|wmv|vob|avi|mp4|m4v|ts)$^;
121}
122
123
124sub extract_keyframes
125{
126 my $self = shift (@_);
127 my ($doc_obj,$originalfilename,$filename) = @_;
128
129 my $section = $doc_obj->get_top_section();
130
131 my $output_dir = $self->{'cached_dir'};
132 my $ivideo_root = $self->{'cached_file_root'};
133
134 # Generate the keyframes with ffmpeg and hive
135 my $ifilename = $originalfilename || $filename;
136 my ($keyframe_cmd,$okeyframe_filename) = $self->keyframe_cmd($ifilename);
137
138 my $keyframe_options = { @{$self->{'ffmpeg_monitor'}},
139 'message_prefix' => "Keyframe",
140 'message' => "Extracting keyframes" };
141
142 $self->run_cached_general_cmd($keyframe_cmd,
143 $ifilename,$okeyframe_filename,
144 $keyframe_options);
145 $self->parse_shot_xml();
146
147 my $keep_keyframe_timeline = $self->{'keep_keyframe_timeline'};
148 $self->associate_keyframes($doc_obj,$section,$keep_keyframe_timeline);
149
150}
151
152
153
154sub extract_thumbnail
155{
156 my $self = shift (@_);
157 my ($doc_obj,$filename,$convertto_regenerated,$thumbnailtype,
158 $thumbnail_width, $thumbnail_height) = @_;
159
160 my $section = $doc_obj->get_top_section();
161
162 my $output_dir = $self->{'cached_dir'};
163 my $ivideo_root = $self->{'cached_file_root'};
164
165 my $verbosity = $self->{'verbosity'};
166 my $outhandle = $self->{'outhandle'};
167
168
169 # Generate the thumbnail with convert, a la ImagePlugin
170
171 my $thumbnailfile = &util::filename_cat($output_dir,"$ivideo_root-thumbnail.$thumbnailtype");
172
173 my $optionally_run_general_cmd = "run_uncached_general_cmd";
174 if ($self->{'enable_cache'}) {
175 $optionally_run_general_cmd
176 = ($convertto_regenerated) ? "regenerate_general_cmd" : "run_cached_general_cmd";
177 }
178
179### print STDERR "**** creating thumbnail: $thumbnail_width x $thumbnail_height\n";
180 my $ofilename = $self->get_ovideo_filename($self->{'enable_streaming'});
181 my ($thumb_cmd ,$othumb_filename)
182 = $self->keyframe_thumbnail_cmd($ofilename,$thumbnailfile,$thumbnail_width,$thumbnail_height);
183
184 my $thumb_options = { 'verbosity' => $verbosity,
185 'outhandle' => $outhandle,
186 'message_prefix' => "Thumbnail",
187 'message' => "Generating thumbnail" };
188
189 my ($thumb_regenerated,$thumb_result,$thumb_had_error)
190 = $self->$optionally_run_general_cmd($thumb_cmd,$ofilename,$thumbnailfile,$thumb_options);
191
192 # Add the thumbnail as an associated file ...
193 if (-e "$thumbnailfile") {
194 $doc_obj->associate_file("$thumbnailfile", "thumbnail.$thumbnailtype",
195 "image/$thumbnailtype",$section);
196 $doc_obj->add_metadata ($section, "ThumbType", $thumbnailtype);
197 $doc_obj->add_metadata ($section, "Thumb", "thumbnail.$thumbnailtype");
198
199 $doc_obj->add_utf8_metadata ($section, "thumbicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Thumb]\" width=[ThumbWidth] height=[ThumbHeight]>");
200### $doc_obj->add_utf8_metadata ($section, "thumbicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Thumb]\">");
201 }
202
203 # Extract Thumnail metadata from convert output
204 if ($thumb_result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
205 $doc_obj->add_metadata ($section, "ThumbWidth", $1);
206 $doc_obj->add_metadata ($section, "ThumbHeight", $2);
207 }
208 else {
209 # Two reasons for getting to here:
210 # 1.thumbnail was generated by ffmpeg, not imagemagick convert
211 # 2.thumbnail was cached, so imagemagick convert was not run
212 # Either way, the solution is the same:
213 # => run "identify $thumbnailfile" and parse result
214 $thumb_result = `identify \"$thumbnailfile\" 2>&1`;
215
216 if ($thumb_result =~ m/([0-9]+)x([0-9]+)/) {
217 $doc_obj->add_metadata ($section, "ThumbWidth", $1);
218 $doc_obj->add_metadata ($section, "ThumbHeight", $2);
219 }
220 }
221}
222
223
224sub extract_keyframes_montage
225{
226 my $self = shift (@_);
227 my ($doc_obj,$filename,$thumbnailtype) = @_;
228
229 my $section = $doc_obj->get_top_section();
230
231 my $output_dir = $self->{'cached_dir'};
232 my $ivideo_root = $self->{'cached_file_root'};
233
234
235 # Generate the mosaic with 'montage'
236 my $montagefile = &util::filename_cat($output_dir,"$ivideo_root\_montage.$thumbnailtype");
237
238 my ($montage_cmd,$omontage_filename)
239 = $self->keyframe_montage_cmd($filename,$montagefile);
240
241 my $montage_options = { 'message_prefix' => "Montage",
242 'message' => "Generating montage" };
243
244 my ($montage_result,$montage_had_error)
245 = $self->run_general_cmd($montage_cmd,$montage_options);
246
247 # Add the montage as an associated file ...
248 if (-e "$montagefile") {
249 $doc_obj->associate_file("$montagefile", "montage.$thumbnailtype",
250 "image/$thumbnailtype",$section);
251 $doc_obj->add_metadata ($section, "MontageType", $thumbnailtype);
252 $doc_obj->add_metadata ($section, "Montage", "montage.$thumbnailtype");
253
254 $doc_obj->add_utf8_metadata ($section, "montageicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Montage]\" >");
255 }
256}
257
258
259
260sub extract_screenview
261{
262 my $self = shift (@_);
263 my ($doc_obj,$filename,$convertto_regenerated, $screenviewtype, $screenview_width,$screenview_height) = @_;
264
265 my $section = $doc_obj->get_top_section();
266
267 my $output_dir = $self->{'cached_dir'};
268 my $ivideo_root = $self->{'cached_file_root'};
269
270 my $optionally_run_general_cmd = "run_uncached_general_cmd";
271 if ($self->{'enable_cache'}) {
272 $optionally_run_general_cmd
273 = ($convertto_regenerated) ? "regenerate_general_cmd" : "run_cached_general_cmd";
274 }
275 # make the screenview image
276
277 my $screenviewfilename = &util::filename_cat($output_dir,"$ivideo_root-screenview.$screenviewtype");
278
279
280 my ($screenview_cmd,$oscreenview_filename)
281 = $self->keyframe_thumbnail_cmd($filename,$screenviewfilename,$screenview_width,$screenview_height);
282
283 my $screenview_options = { 'message_prefix' => "Screenview",
284 'message' => "Generating screenview image" };
285
286
287 my ($screenview_regenerated,$screenview_result,$screenview_had_error)
288 = $self->$optionally_run_general_cmd($screenview_cmd,
289 $filename,$screenviewfilename,
290 $screenview_options);
291
292
293 # get screenview dimensions, size and type
294 if ($screenview_result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
295 $doc_obj->add_metadata ($section, "ScreenWidth", $1);
296 $doc_obj->add_metadata ($section, "ScreenHeight", $2);
297 }
298 else {
299 $doc_obj->add_metadata ($section, "ScreenWidth", $screenview_width);
300 $doc_obj->add_metadata ($section, "ScreenHeight", $screenview_height);
301 }
302
303 #add the screenview as an associated file ...
304 if (-e "$screenviewfilename") {
305 $doc_obj->associate_file("$screenviewfilename", "screenview.$screenviewtype",
306 "image/$screenviewtype",$section);
307 $doc_obj->add_metadata ($section, "ScreenType", $screenviewtype);
308 $doc_obj->add_metadata ($section, "Screen", "screenview.$screenviewtype");
309
310 $doc_obj->add_utf8_metadata ($section, "screenicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Screen]\" width=[ScreenWidth] height=[ScreenHeight]>");
311 } else {
312 my $outhandle = $self->{'outhandle'};
313 print $outhandle "VideoPlugin: couldn't find \"$screenviewfilename\"\n";
314 }
315}
316
317
318# Create the keyframes, thumbnail and screenview images, and discover
319# the Video's size, width, and height using the ffmpeg utility.
320
321sub run_convert {
322 my $self = shift (@_);
323 my $base_dir = shift (@_);
324 my $filename = shift (@_); # filename with full path
325 my $file = shift (@_); # filename without path
326 my $doc_obj = shift (@_);
327
328 my $section = $doc_obj->get_top_section();
329
330 my $verbosity = $self->{'verbosity'};
331 my $outhandle = $self->{'outhandle'};
332
333 # check the filename is okay
334 return 0 if ($file eq "" || $filename eq "");
335
336 my $minimumsize = $self->{'minimumsize'};
337 if (defined $minimumsize && (-s $filename < $minimumsize)) {
338 print $outhandle "VideoPlugin: \"$filename\" too small, skipping\n"
339 if ($verbosity > 1);
340 }
341
342 my ($video_type, $video_width, $video_height, $video_duration, $durationDisplay, $video_size,
343 $vcodec,$vrate,$vfps,$atype,$afreq,$achan,$arate)
344 = &VideoConverter::identify($filename, $outhandle, $verbosity);
345
346 if ($video_duration =~ m/^(\d\d):(\d\d):(\d\d)\.(\d)$/) {
347 $video_duration = $1*3600 + $2*60 + $3 + ($4/10.0);
348 }
349
350 #if ($vfps eq "unknown") {
351 #print $outhandle "Unknown framerate, defaulting to 25 frames per second.\n";
352 #$vfps = 25;
353 #}
354
355 #my ($dur_hour,$dur_min,$dur_sec)
356 #= ($video_duration =~ m/(\d+):(\d+):(\d+\.\d+)/);
357 #my $total_dur_secs = $dur_hour*3600 + $dur_min*60 + $dur_sec;
358
359 my $total_dur_secs = $video_duration / 1000;
360
361 $self->{'video-fps'} = $vfps;
362 $self->{'num-total-frames'} = $total_dur_secs * $vfps;
363
364 # Convert the video to a new type (if required).
365 my $converttotype = $self->{'converttotype'};
366 my $converttosize = $self->{'converttosize'};
367
368 # shorten duration prcessed for experimentation purposes
369 my $exp_duration = undef;
370
371 my $excerpt_duration = $self->{'excerpt_duration'};
372
373 if ((defined $excerpt_duration) && ($excerpt_duration ne "")) {
374 $exp_duration = $excerpt_duration;
375 my ($hh,$mm,$ss,$ms);
376
377 if ($exp_duration =~ m/^(\d\d):(\d\d):(\d\d)\.?(\d\d)?/) {
378 $hh = $1;
379 $mm = $2;
380 $ss = $3;
381 $ms = $4;
382 }
383 else {
384 # assume value is in seconds
385 $hh = 0;
386 $mm = 0;
387 $ss = $exp_duration;
388 $ms = 0;
389 }
390
391 my $excerpt_dur_in_secs = $hh * 3600 + $mm * 60 + $ss;
392
393 if ($excerpt_dur_in_secs < $total_dur_secs) {
394 $self->{'num-total-frames'} = $excerpt_dur_in_secs * $vfps; # override calculation for full length duration
395 }
396 else {
397 # clip is already shorter than requested video excerpt duration
398 # set exp_duration back to undefined
399 $exp_duration = undef;
400 }
401 }
402
403
404 if (defined $exp_duration)
405 {
406 print $outhandle "Only encoding first $exp_duration of video.\n";
407 $self->{'exp_duration'} = $exp_duration;
408 }
409
410 my $ascii_only_filenames = $self->{'use_ascii_only_filenames'};
411 $self->init_cache_for_file($filename);
412
413 my $originalfilename = undef;
414 my $type = "unknown";
415
416 my $output_dir = $self->{'cached_dir'};
417 my $ivideo_root = $self->{'cached_file_root'};
418
419 my $convertto_regenerated = 0;
420 if (($converttotype ne "" && $filename =~ m/$converttotype$/i) ||
421 (($converttosize ne "" && $converttosize ne $video_width) || ($converttosize ne "" && $converttosize ne $video_height))) {
422 if ($converttotype eq "") {
423 # in this block because the video width x height different to original
424 # => set (for this call to run_convert only) converttotype
425 # to input file extension
426 ($converttotype) = ($filename =~ m/\.(.*?)$/);
427 }
428
429 $originalfilename = $filename;
430
431 $file = "$ivideo_root.$converttotype";
432 $filename = &util::filename_cat($output_dir,$file);
433
434 my $s_opt = $self->optional_frame_scale($converttosize,$video_width,$video_height);
435 my $exp_duration = $self->{'exp_duration'};
436 my $t_opt = (defined $exp_duration) ? "-t $exp_duration" : "";
437
438 my $main_opts = "-y $t_opt $s_opt";
439
440
441 my $originalfilename_gsdlenv = $self->gsdlhome_independent($originalfilename);
442 my $filename_gsdlenv = $self->gsdlhome_independent($filename);
443
444
445 my $convertto_command = "ffmpeg $main_opts -i \"$originalfilename_gsdlenv\"";
446 $convertto_command .= " -ar 22050" if ($converttotype eq "flv");
447 $convertto_command .= " -y \"$filename_gsdlenv\"";
448
449 my $convertto_result;
450 my $convertto_error;
451
452 my $convertto_options = { @{$self->{'ffmpeg_monitor'}},
453 'message_prefix' => "Convert to",
454 'message' => "Converting video to $converttotype" };
455
456 ($convertto_regenerated,$convertto_result,$convertto_error)
457 = $self->run_cached_general_cmd($convertto_command,
458 $originalfilename,$filename,
459 $convertto_options);
460
461 $type = $converttotype;
462 }
463
464
465 # Add the video metadata
466
467 my $file_unicode = pack("U0C*", map { ord($_) } split(//,$file)); # force explicitly to unicode
468
469 $file_unicode =~ s/\x{2018}|\x{2019}|\x{201C}|\x{201D}//g; # remove smart quotes as cause problem in URL for video server
470 $file_unicode =~ s/\x{2013}/\-/g; # change en-dash to '-' as again causes problems for video server
471
472## print STDERR "**** file metadata = ", &gsprintf::debug_unicode_string($file_unicode), "\n";
473
474
475 # split filename on char if specified
476 if (0) {
477# don't do any more
478# if ($file_unicode =~ m/\-/) {
479
480 my @file_split = split(/\s*\-\s*/,$file_unicode);
481 my $creator = shift @file_split;
482 my $title = shift @file_split;
483
484 $title =~ s/\..*?$//;
485 $title =~ s/^(.)/\u$1/;
486
487 $doc_obj->add_utf8_metadata($section,"Title",$title);
488
489 my @creator_split = split(/\s+and\s+/,$creator);
490 foreach my $c (@creator_split) {
491 $doc_obj->add_utf8_metadata($section,"Creator",$c);
492 }
493 }
494
495 $file = $file_unicode;
496 my $filemeta = $self->filename_to_utf8_metadata($file);
497 my $filemeta_url_safe = $self->url_safe($filemeta);
498
499 $doc_obj->add_utf8_metadata ($section, "Video", $filemeta_url_safe);
500
501 # Also want to set filename as 'Source' metadata to be
502 # consistent with other plugins
503 # $doc_obj->add_utf8_metadata ($section, "Source", $filemeta_url_safe);
504
505
506 if ($video_type ne " ") {
507 $type = $video_type;
508 }
509
510 $doc_obj->add_metadata ($section, "FileFormat", $type);
511 $doc_obj->add_metadata ($section, "FileSize", $video_size);
512
513 $doc_obj->add_metadata ($section, "VideoType", $video_type);
514 $doc_obj->add_metadata ($section, "VideoWidth", $video_width);
515 $doc_obj->add_metadata ($section, "VideoHeight", $video_height);
516 $doc_obj->add_metadata ($section, "VideoDuration", $video_duration);
517 $doc_obj->add_metadata ($section, "VideoSize", $video_size);
518
519 $doc_obj->add_metadata ($section, "VideoCodec", $vcodec);
520 $doc_obj->add_metadata ($section, "VideoFPS", $vfps);
521
522 $doc_obj->add_metadata ($section, "AudioType", $atype);
523 $doc_obj->add_metadata ($section, "AudioFreq", $afreq);
524 $doc_obj->add_metadata ($section, "AudioChannels", $achan);
525 $doc_obj->add_metadata ($section, "AudioRate", $arate);
526
527 $doc_obj->add_utf8_metadata ($section, "srclink",
528 "<a href=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Video]\">");
529 $doc_obj->add_utf8_metadata ($section, "/srclink", "</a>");
530 $doc_obj->add_metadata ($section, "srcicon", "[VideoType]");
531
532
533 # Add the original file as an associated file
534 if ($self->{'keep_original_video'} eq "true") {
535 $doc_obj->associate_file($filename,$file,"video/$type",$section);
536 }
537
538
539 if ($self->{'extract_keyframes'}) {
540 $self->extract_keyframes($doc_obj,$originalfilename,$filename);
541 }
542
543 my $streamable_regenerated = 0;
544
545 # Create a VP6+MP3 streaming ready video file with FFMpeg
546 if ($self->{'enable_streaming'} eq "flv") {
547 $streamable_regenerated
548 = $self->enable_full_streaming($doc_obj,
549 $originalfilename,$filename,
550 $convertto_regenerated,
551 $video_width,$video_height);
552 }
553
554 # Create an H264+ACC streaming ready video file with Handbrake
555 if ($self->{'enable_streaming'} eq "mp4") {
556 $streamable_regenerated
557 = $self->enable_h264_streaming($doc_obj,
558 $originalfilename,$filename,
559 $convertto_regenerated,
560 $video_width,$video_height);
561 }
562
563 my $thumbnailsize = $self->{'thumbnailsize'} || 100;
564 my $thumbnailtype = $self->{'thumbnailtype'} || 'jpg';
565
566
567 if ($self->{'create_thumbnail'} eq "true") {
568
569 my $thumbnail_width;
570 my $thumbnail_height;
571
572 if ($video_width>$video_height) {
573 my $scale_ratio = $video_height / $video_width;
574 $thumbnail_width = $thumbnailsize;
575 $thumbnail_height = int($thumbnailsize * $scale_ratio);
576 }
577 else {
578 my $scale_ratio = $video_width / $video_height;
579 $thumbnail_width = int($thumbnailsize * $scale_ratio);
580 $thumbnail_height = $thumbnailsize;
581 }
582
583 # for some video formats, extracted size needs to be multiple of 2
584 $thumbnail_width = int($thumbnail_width/2) * 2;
585 $thumbnail_height = int($thumbnail_height/2) * 2;
586
587 $self->extract_thumbnail($doc_obj,$filename,$convertto_regenerated,
588 $thumbnailtype,
589 $thumbnail_width,$thumbnail_height);
590 }
591
592 if ($self->{'extract_keyframes'}) {
593 $self->extract_keyframes_montage($doc_obj,$filename,$thumbnailtype);
594 }
595
596 my $screenviewsize = $self->{'screenviewsize'};
597 my $screenviewtype = $self->{'screenviewtype'} || 'jpeg';
598
599 # Make a screen-sized version of the picture if requested
600 if ($self->{'create_screenview'} eq "true") {
601
602 # To do: if the actual image smaller than the screenview size,
603 # we should use the original !
604
605 my $screenview_width;
606 my $screenview_height;
607
608 if ($video_width>$video_height) {
609 my $scale_ratio = $video_height / $video_width;
610 $screenview_width = $screenviewsize;
611 $screenview_height = int($screenviewsize * $scale_ratio);
612 }
613 else {
614 my $scale_ratio = $video_width / $video_height;
615 $screenview_width = int($screenviewsize * $scale_ratio);
616 $screenview_height = $screenviewsize;
617 }
618
619
620 # for some video formats, extracted size needs to be multiple of 2
621 $screenview_width = int($screenview_width/2) * 2;
622 $screenview_height = int($screenview_height/2) * 2;
623
624 $self->extract_screenview($doc_obj,$filename, $convertto_regenerated,
625 $screenviewtype,
626 $screenview_width,$screenview_height);
627 }
628
629 return $type;
630}
631
632
633
634
635sub read_into_doc_obj {
636 my $self = shift (@_);
637 my ($pluginfo, $base_dir, $file, $block_hash, $metadata, $processor, $maxdocs, $total_count, $gli) = @_;
638
639 $self->{'media_type'} = "video";
640
641 my ($rv,$doc_obj) = $self->SUPER::read_into_doc_obj(@_);
642
643 if ($rv != 1) {
644 return ($rv,$doc_obj);
645 }
646
647 my $enable_streaming
648 = ($self->{'enable_flv_streaming'} || $self->{'enable_mp4_streaming'})
649 ? 1 : 0;
650
651 if (($enable_streaming) && ($self->{'extract_keyframes'})) {
652 my $section = $doc_obj->get_top_section();
653 my $oflash_filename = $self->{'oflash_filename'};
654 my ($streamkeyframes_cmd,$ostreamkeyframes_filename)
655 = $self->streamkeyframes_cmd($oflash_filename,$doc_obj,$section);
656
657 my $verbosity = $self->{'verbosity'};
658
659 my $streamkeyframes_options = { @{$self->{'flvtool2_monitor'}},
660 'message_prefix' => "Stream Keyframes",
661 'message' => "Reprocessing video stream to add keyframes on timeline" };
662
663 $self->run_general_cmd($streamkeyframes_cmd,$streamkeyframes_options);
664 }
665
666 my ($filename_full_path, $filename_no_path) = &util::get_full_filenames($base_dir, $file);
667 my $section = $doc_obj->get_top_section();
668
669 $self->title_fallback($doc_obj,$section,$filename_no_path);
670
671 $self->{'media_type'} = undef;
672
673 return ($rv,$doc_obj);
674}
675
676
677
678
679sub output_distributed_keyframes
680{
681 my ($self) = shift @_;
682 my ($timeline,$num_dist_frames) = @_;
683
684 my $num_total_frames = $self->{'num-total-frames'};
685
686 my $keep_timeline = {};
687
688 my $frame_delta;
689 if ($num_dist_frames eq "all") {
690 $frame_delta = undef;
691 }
692 else {
693 $frame_delta = $num_total_frames/$num_dist_frames;
694 }
695
696 my $closest_to = $frame_delta;
697 my $prev_t = 0;
698
699# print STDERR "*** num total frames = $num_total_frames\n";
700# print STDERR "*** frame delta = $frame_delta\n";
701
702 my $keep_keyframe_num = 1;
703
704 foreach my $curr_t (sort { $a <=> $b } keys %$timeline)
705 {
706# print STDERR "*** curr_t = $curr_t\n";
707
708 my $timeline_rec = undef;
709
710 if (!defined $closest_to) {
711 $timeline_rec = $timeline->{$curr_t};
712 $keep_timeline->{$curr_t} = $timeline_rec;
713 }
714 elsif ($curr_t>$closest_to) {
715 # decide if previous t (prev_t_ or current t (curr_t) is closest
716
717 my $prev_t_dist = $closest_to - $prev_t;
718 my $curr_t_dist = $curr_t - $closest_to;
719
720 if ($curr_t_dist <= $prev_t_dist)
721 {
722 $timeline_rec = $timeline->{$curr_t};
723 $keep_timeline->{$curr_t} = $timeline_rec;
724
725 }
726 else
727 {
728 $timeline_rec = $timeline->{$prev_t};
729 $keep_timeline->{$prev_t} = $timeline_rec;
730 }
731
732 $closest_to += $frame_delta;
733 }
734
735 if (defined $timeline_rec) {
736
737 my $name = $timeline_rec->{'name'};
738 my $timestamp = $timeline_rec->{'timestamp'};
739 my $thumb = $timeline_rec->{'thumb'};
740 my $keyframe_num = $timeline_rec->{'keyframenum'};
741
742
743 print CUEOUT " <metatag event=\"onCuePoint\" overwrite=\"true\">\n";
744 print CUEOUT " <name>$name</name>\n";
745 print CUEOUT " <timestamp>$timestamp</timestamp>\n";
746 print CUEOUT " <parameters>\n";
747 print CUEOUT " <thumb>$thumb</thumb>\n";
748 print CUEOUT " <keyframeNum>$keyframe_num</keyframeNum>\n";
749 print CUEOUT " <keepKeyframeNum>$keep_keyframe_num</keepKeyframeNum>\n";
750 print CUEOUT " </parameters>\n";
751 print CUEOUT " <type>navigation</type>\n";
752 print CUEOUT " </metatag>\n";
753
754# my $testtime = $timestamp+1000;
755# print CUEOUT " <metatag event=\"onCuePoint\" overwrite=\"true\">\n";
756# print CUEOUT " <name>Test $name</name>\n";
757# print CUEOUT " <timestamp>$testtime</timestamp>\n";
758# print CUEOUT " <parameters>\n";
759# print CUEOUT " <thumb>$thumb</thumb>\n";
760# print CUEOUT " <secnum>1</secnum>\n";
761# print CUEOUT " <subsecnum>0</subsecnum>\n";
762# print CUEOUT " </parameters>\n";
763# print CUEOUT " <type>event</type>\n";
764# print CUEOUT " </metatag>\n";
765
766 $keep_keyframe_num++;
767
768 }
769 $prev_t = $curr_t;
770 }
771
772 $self->{'keep_keyframe_timeline'} = $keep_timeline;
773}
774
775
776sub StartDocument {$_[0]->{'PluginObj'}->xml_start_document(@_);}
777sub XMLDecl {$_[0]->{'PluginObj'}->xml_xmldecl(@_);}
778sub Entity {$_[0]->{'PluginObj'}->xml_entity(@_);}
779sub Doctype {$_[0]->{'PluginObj'}->xml_doctype(@_);}
780sub StartTag {$_[0]->{'PluginObj'}->xml_start_tag(@_);}
781sub EndTag {$_[0]->{'PluginObj'}->xml_end_tag(@_);}
782sub Text {$_[0]->{'PluginObj'}->xml_text(@_);}
783sub PI {$_[0]->{'PluginObj'}->xml_pi(@_);}
784sub EndDocument {$_[0]->{'PluginObj'}->xml_end_document(@_);}
785sub Default {$_[0]->{'PluginObj'}->xml_default(@_);}
786
787
788# This Char function overrides the one in XML::Parser::Stream to overcome a
789# problem where $expat->{Text} is treated as the return value, slowing
790# things down significantly in some cases.
791sub Char {
792 use bytes; # Necessary to prevent encoding issues with XML::Parser 2.31+
793 $_[0]->{'Text'} .= $_[1];
794 return undef;
795}
796
797sub xml_start_document {
798 my $self = shift(@_);
799 my ($expat, $name, $sysid, $pubid, $internal) = @_;
800
801}
802
803# Called for XML declarations
804sub xml_xmldecl {
805 my $self = shift(@_);
806 my ($expat, $version, $encoding, $standalone) = @_;
807}
808
809# Called for XML entities
810sub xml_entity {
811 my $self = shift(@_);
812 my ($expat, $name, $val, $sysid, $pubid, $ndata) = @_;
813}
814
815
816# Called for DOCTYPE declarations - use die to bail out if this doctype
817# is not meant for this plugin
818sub xml_doctype {
819 my $self = shift(@_);
820 my ($expat, $name, $sysid, $pubid, $internal) = @_;
821
822 # This test used to be done in xml_start_document
823 # Moved to here as seems more logical
824
825 if ($name !~ "seg") {
826 die "VideoPlugin: Root tag $name does not match expected <seg>";
827 }
828}
829
830
831sub xml_start_tag {
832 my $self = shift(@_);
833 my ($expat, $element) = @_;
834
835 my %attr = %_;
836
837 if ($element eq "seg") {
838 $self->{'keyframe_index'} = 0;
839 $self->{'keyframe_fnames'} = [];
840 $self->{'keyframe_timeline'} = {};
841
842 #$self->{'flowplayer_thumblist'} = "thumbs: \\[";
843
844 my $output_dir = $self->{'cached_dir'};
845 my $cue_filename = &util::filename_cat($output_dir,"on_cue.xml");
846
847 open(CUEOUT,">$cue_filename")
848 || die "Unable to open $cue_filename: $!\n";
849 print CUEOUT "<tags>\n";
850 }
851 elsif ($element eq "trans") {
852 my $trans_type = $attr{'type'};
853 my $pre_frame_num = $attr{'preFNum'};
854 my $post_frame_num = $attr{'postFNum'};
855
856 my $avg_frame_num = int(($pre_frame_num+$post_frame_num)/2.0)+1;
857
858 my $output_dir = $self->{'cached_dir'};
859 my $ivideo_root = $self->{'cached_file_root'};
860
861 my $keyframe_index = $self->{'keyframe_index'};
862
863 my $fps = $self->{'video-fps'};
864
865 if ($keyframe_index==0)
866 {
867 # hive actually generates one extra keyframe at the start,
868 # which is half way between frame 0 and the frist pre_frame
869
870 my $thumb_file = sprintf("%s_%04d.jpg",$ivideo_root,$keyframe_index);
871 my $thumb_filename = &util::filename_cat($output_dir,$thumb_file);
872 push(@{$self->{'keyframe_fnames'}},$thumb_file);
873
874 my $half_frame_num = $pre_frame_num/2.0;
875 my $time_msec = ($half_frame_num / $fps) * 1000;
876
877# print CUEOUT " <metatag event=\"onCuePoint\" overwrite=\"true\">\n";
878# print CUEOUT " <name>Keyframe $keyframe_index</name>\n";
879# print CUEOUT " <timestamp>$time_msec</timestamp>\n";
880# print CUEOUT " <parameters>\n";
881# print CUEOUT " <thumb>$thumb_file</thumb>\n";
882# print CUEOUT " </parameters>\n";
883# print CUEOUT " <type>navigation</type>\n";
884# print CUEOUT " </metatag>\n";
885
886
887 my $timeline_rec = { 'name'=> "Keyframe $keyframe_index",
888 'keyframeindex' => $keyframe_index,
889 'timestamp' => $time_msec,
890 'thumb' => $thumb_file,
891 'keyframenum' => $keyframe_index};
892
893 $self->{'keyframe_timeline'}->{$half_frame_num}=$timeline_rec;
894 }
895
896 $keyframe_index++;
897
898 my $thumb_file = sprintf("%s_%04d.jpg",$ivideo_root,$keyframe_index);
899 my $thumb_filename = &util::filename_cat($output_dir,$thumb_file);
900 push(@{$self->{'keyframe_fnames'}},$thumb_file);
901
902 my $time_msec = (($avg_frame_num) / $fps) * 1000;
903 my $time_sec = (($avg_frame_num)/ $fps);
904
905# print CUEOUT " <metatag event=\"onCuePoint\" overwrite=\"true\">\n";
906# print CUEOUT " <name>Keyframe $keyframe_index</name>\n";
907# print CUEOUT " <timestamp>$time_msec</timestamp>\n";
908# print CUEOUT " <parameters>\n";
909# print CUEOUT " <thumb>$thumb_file</thumb>\n";
910# print CUEOUT " </parameters>\n";
911# print CUEOUT " <type>navigation</type>\n";
912# print CUEOUT " </metatag>\n";
913
914
915 my $timeline_rec = { 'name'=> "Keyframe $keyframe_index",
916 'keyframeindex' => $keyframe_index,
917 'timestamp' => $time_msec,
918 'thumb' => $thumb_file,
919 'keyframenum' => $keyframe_index};
920
921 $self->{'keyframe_timeline'}->{$avg_frame_num}=$timeline_rec;
922
923 # $self->{'flowplayer_thumblist'} .= "\\{ thumbNail: '$thumb_file', time: $time_sec \\},";
924
925 $self->{'keyframe_index'} = $keyframe_index;
926 }
927}
928
929sub xml_end_tag {
930 my $self = shift(@_);
931 my ($expat, $element) = @_;
932
933 if ($element eq "seg") {
934
935 $self->output_distributed_keyframes($self->{'keyframe_timeline'},$self->{'keep_keyframes'});
936
937
938 print CUEOUT "</tags>\n";
939 close(CUEOUT);
940
941 #$self->{'flowplayer_thumblist'} .= "\\]";
942 }
943}
944
945
946
947
948
949# Called just before start or end tags with accumulated non-markup text in
950# the $_ variable.
951sub xml_text {
952 my $self = shift(@_);
953 my ($expat) = @_;
954}
955
956# Called for processing instructions. The $_ variable will contain a copy
957# of the pi.
958sub xml_pi {
959 my $self = shift(@_);
960 my ($expat, $target, $data) = @_;
961}
962
963# Called at the end of the XML document.
964sub xml_end_document {
965 my $self = shift(@_);
966 my ($expat) = @_;
967
968 # ****
969 # $self->close_document();
970}
971
972
973# Called for any characters not handled by the above functions.
974sub xml_default {
975 my $self = shift(@_);
976 my ($expat, $text) = @_;
977}
978
979
9801;
981
982
983
984
985
986
987
988
989
990
991
Note: See TracBrowser for help on using the repository browser.