Moved Video to SMPGEG. Maybe move this to SDL::Game::Video later

[sdlgit/SDL_perl.git] / lib / SDL / SMPEG.pm

diff --git a/lib/SDL/SMPEG.pm b/lib/SDL/SMPEG.pm
new file mode 100644 (file)
index 0000000..5091ce8
--- /dev/null
+++ b/lib/SDL/SMPEG.pm
@@ -0,0 +1,213 @@
+#!perl
+package SDL::SMPEG;
+
+use strict;
+use warnings;
+use Carp;
+use SDL;
+use SDL::Surface;
+use SDL::MPEG;
+
+sub new {
+       my $proto = shift;
+       my $class = ref($proto) || $proto;
+       my %options = @_;
+
+       verify (%options, qw/ -name -audio / ) if $SDL::DEBUG;
+
+       my $n = $options{-name} || die "SDL::SMPEG must supply a filename to SDL::SMPEG::new\n";
+       my $a = $options{'-audio'} ? 1 : 0;
+       my $info = new SDL::MPEG();
+       
+       my $self = \SDL::NewSMPEG($n,$$info,$a);
+       croak SDL::GetError() unless $$self;
+       bless $self,$class;
+       $self->audio(1);
+       $self->video(1);
+       return $self, $info;
+}
+
+sub DESTROY {
+       SDL::FreeSMPEG(${$_[0]});
+}
+
+sub error {
+       SDL::SMPEGError(${$_[0]});
+}
+
+sub audio {
+       SDL::SMPEGEnableAudio( ${$_[0]}, $_[1]);
+}
+
+sub video {
+       SDL::SMPEGEnableSMPEG( ${$_[0]}, $_[1]);
+}
+
+sub volume {
+       SDL::SMPEGSetVolume( ${$_[0]}, $_[1] );
+}
+
+sub display {
+       croak "SDL::SMPEG::Display requires a SDL::Surface\n" unless $_[1]->isa('SDL::Surface');
+       SDL::SMPEGSetDisplay( ${$_[0]}, ${$_[1]}, 0);
+}
+
+sub scale {
+       return SDL::SMPEGScaleXY(${$_[0]},$_[1],$_[2]) if (@_ == 3 );
+       return SDL::SMPEGScaleXY(${$_[0]},$_[1]->width(),$_[1]->height()) if $_[1]->isa('SDL::Surface');
+       SDL::SMPEGScale(${$_[0]},$_[1]);
+}
+
+sub play {
+       SDL::SMPEGPlay(${$_[0]});
+}
+
+sub pause {
+       SDL::SMPEGPause(${$_[0]});
+}
+
+sub stop {
+       SDL::SMPEGStop(${$_[0]});
+}
+
+sub rewind {
+       SDL::SMPEGRewind(${$_[0]});
+}
+
+sub seek {
+       SDL::SMPEGSeek(${$_[0]},$_[1]);
+}
+
+sub skip {
+       SDL::SMPEGSkip(${$_[0]},$_[1]);
+}
+
+sub loop {
+       SDL::SMPEGLoop(${$_[0]},$_[1]);
+}
+
+sub region {
+       croak "SDL::SMPEG::region requires a SDL::Rect\n" unless $_[1]->isa('SDL::Rect');
+       SDL::SMPEGDisplayRegion(${$_[0]},${$_[1]});
+}
+
+sub frame {
+       SDL::SMPEGRenderFrame(${$_[0]},$_[1]);
+}
+
+sub info {
+       new SDL::MPEG -from => $_[0];
+}
+
+sub status {
+       SDL::SMPEGStatus(${$_[0]});
+}
+
+1;
+
+__END__;
+
+=pod
+
+
+=head1 NAME
+
+SDL::SMPEG - a SDL perl extension
+
+=head1 SYNOPSIS
+
+  $video = new SDL::SMPEG ( -name => 'pr0n.mpg' );
+
+=head1 DESCRIPTION
+
+C<SDL::SMPEG> adds support for MPEG video to your
+SDL Perl application.  SMPEGs are objects bound to
+surfaces, whose playback is controled through the
+object's interface.
+
+=head2 METHODS 
+
+
+=over 4
+
+=item *
+
+C<SDL::SMPEG::error()> returns any error messages associated with playback 
+
+=item * 
+
+C<SDL::SMPEG::audio(bool)> enables or disables audio playback, (on by default)
+
+=item * 
+
+C<SDL::SMPEG::video(bool)> enables or disable video playback, (on by default)
+
+=item * 
+
+C<SDL::SMPEG::loop(bool)> enables or disable playback looping (off by default) 
+
+=item * 
+
+C<SDL::SMPEG::volume(int)> set the volume as per the mixer volume
+
+=item * 
+
+C<SDL::SMPEG:display(surface)> binds the clip to a display surface
+
+=item * 
+
+C<SDL::SMPEG::scale([x,y]|[surface]|int)> scales the clip by either x,y
+factors, scales to the image dimensions, or a single scalar.
+
+=item * 
+
+C<SDL::SMPEG::play()> plays the video clip, call C<SDL::SMPEG::display()> before playing
+
+=item * 
+
+C<SDL::SMPEG::pause()> pauses video playback
+
+=item * 
+
+C<SDL::SMPEG::stop()> stops video playback
+
+=item * 
+
+C<SDL::SMPEG::rewind()> resets the clip to the beginning 
+
+=item * 
+
+C<SDL::SMPEG::seek(offset)> seeks to a particular byte offset
+
+=item * 
+
+C<SDL::SMPEG::skip(time)> skips to a particular time
+
+=item * 
+
+C<SDL::SMPEG::region(rect)> takes a SDL::Rect and defines the display area
+
+=item * 
+
+C<SDL::SMPEG::frame(int)> renders a specific frame to the screen
+
+=item * 
+
+C<SDL::SMPEG::info()> returns a new C<SDL::MPEG> object reflecting the current status
+
+=item *
+
+C<SDL::SMPEG::status()> returns either SMPEG_PLAYING or SMPEG_STOPPED or SMPEG_ERROR
+
+=back
+
+=head1 AUTHOR
+
+David J. Goehrig
+
+=head1 SEE ALSO
+
+perl(1) SDL::Surface(3) SDL::MPEG(3)
+
+=cut
+