added CPSound, an HTML5 wrapper for NSSound

2026-08-25 21:17:03 +00:00 · 2010-11-06 18:37:17 +01:00
parent e3b6cbcee9
commit e4b47090ba
1 changed files with 239 additions and 0 deletions
@@ -0,0 +1,239 @@
+/*
+ * CPSound.j
+ *
+ * Copyright (C) 2010  Antoine Mercadal <antoine.mercadal@inframonde.eu>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+@import <Foundation/CPObject.j>
+
+CPSoundLoadStateEmpty       = 0;
+CPSoundLoadStateLoading     = 1;
+CPSoundLoadStateCanBePlayed = 1;
+
+CPSoundPlayBackStatePlay    = 0;
+CPSoundPlayBackStateStop    = 1;
+CPSoundPlayBackStatePause   = 2;
+
+
+/*! TNSound is a Cappuccino for binding for HTML5 audio element
+    respecting the NSSound protocol
+
+    CPSound delegate:
+        - sound:didFinishPlaying: called when sound has finished to played
+
+*/
+@implementation CPSound : CPObject
+{
+    CPString            _name       @accessors(property=name);
+    id                  _delegate   @accessors(property=delegate);
+
+    HTMLAudioElement    _audioTag;
+    int                 _loadStatus;
+    int                 _playBackStatus;
+}
+
+#pragma mark -
+#pragma mark Initialization
+
+- (id)init
+{
+    if (self = [super init])
+    {
+        _loadStatus = CPSoundLoadStateEmpty;
+        _loops = NO;
+        _audioTag = new Audio();
+        _audioTag.preload = YES;
+        _audioTag.addEventListener("canplay", function(){
+            [self _soundDidload];
+        })
+        _audioTag.addEventListener("ended", function(){
+            [self _soundDidEnd];
+        })
+
+    }
+
+    return self;
+}
+
+/*! init the sound with contents of file located at url represetend by CPString.
+    @param aFile CPString containing the path of the sound
+    @param byRef ignored. keeped for Cocoa compat
+*/
+- (id)initWithContentsOfFile:(CPString)aFile byReference:(BOOL)byRef
+{
+    if (self = [self init])
+    {
+        _loadStatus = CPSoundLoadStateLoading;
+        _audioTag.src = aFile;
+    }
+
+    return self;
+}
+
+/*! init the sound with contents of file located at CURL.
+    @param aFile CPURL containing the URL of the sound
+    @param byRef ignored. keeped for Cocoa compat
+*/
+- (id)initWithContentsOfURL:(CPURL)anURL byReference:(BOOL)byRef
+{
+    return [self initWithContentsOfFile:[anURL absoluteString] byReference:NO];
+}
+
+/*! init the sound with contents given CPData.
+    @param aFile CPData containing the sound
+    @param byRef ignored. keeped for Cocoa compat
+*/
+- (id)initWithData:(CPData)someData
+{
+    if (self = [self init])
+    {
+        _loadStatus = CPSoundLoadStateLoading;
+        _audioTag.src = [someData rawString];
+    }
+
+    return self;
+}
+
+
+#pragma mark -
+#pragma mark Events listener
+
+/*! @ignore
+*/
+- (void)_soundDidload
+{
+    _loadStatus = CPSoundLoadStateCanBePlayed;
+}
+
+/*! @ignore
+*/
+- (void)_soundDidEnd
+{
+    if (_delegate && [_delegate respondsToSelector:@selector(sound:didFinishPlaying:)])
+        [_delegate sound:self didFinishPlaying:YES];
+}
+
+
+#pragma mark -
+#pragma mark Media controls
+
+/*! play the sound
+*/
+- (void)play
+{
+    if ((_loadStatus !== CPSoundLoadStateCanBePlayed)
+        || (_playBackStatus === CPSoundPlayBackStatePlay))
+        return;
+
+    _audioTag.play();
+    _playBackStatus = CPSoundPlayBackStatePlay;
+}
+
+/*! stop the sound
+*/
+- (void)stop
+{
+    if ((_loadStatus !== CPSoundLoadStateCanBePlayed)
+        || (_playBackStatus === CPSoundPlayBackStateStop))
+        return;
+
+    _audioTag.pause();
+    _audioTag.currentTime = 0.0;
+    _playBackStatus = CPSoundPlayBackStateStop;
+}
+
+/*! pause the sound
+*/
+- (void)pause
+{
+    if ((_loadStatus !== CPSoundLoadStateCanBePlayed)
+        || (_playBackStatus === CPSoundPlayBackStatePause))
+        return;
+
+    _audioTag.pause();
+    _playBackStatus = CPSoundPlayBackStatePause;
+}
+
+/*! resume paused sound
+*/
+- (void)resume
+{
+    if ((_loadStatus !== CPSoundLoadStateCanBePlayed)
+        || (_playBackStatus !== CPSoundPlayBackStatePause))
+        return;
+
+    _audioTag.play();
+    _playBackStatus = CPSoundPlayBackStatePlay;
+}
+
+/*! return if the sounds is in loop mode
+    @return BOOL YES if in loop mode, NO otherwise
+*/
+- (BOOL)loops
+{
+    return _audioTag.loop;
+}
+
+/*! set if the sounds should be in loop mode
+    @param BOOL YES for loop mode, NO otherwise
+*/
+- (void)setLoops:(BOOL)shouldLoop
+{
+    _audioTag.loop = shouldLoop;
+}
+
+/*! return value of the volume
+    @return double from 0.0 to 1.0
+*/
+- (BOOL)volume
+{
+    return _audioTag.volume;
+}
+
+/*! set if the sounds should be in loop mode
+    @param double set the volume value
+*/
+- (void)setVolume:(double)aVolume
+{
+    if (aVolume > 1.0)
+        aVolume = 1.0;
+    else if (aVolume < 0.0)
+        aVolume = 0.0;
+
+    _audioTag.volume = aVolume;
+}
+
+#pragma mark -
+#pragma mark Accessors
+
+/*! return the duration in seconds of the sound
+    @return double the duration
+*/
+- (double)duration
+{
+    return _audioTag.duration;
+}
+
+/*! return if sound is playing or not
+    @return BOOL YES is sound is playing, NO otherwise
+*/
+- (BOOL)isPlaying
+{
+    return (_playBackStatus === CPSoundPlayBackStatePlay) ? YES : NO;
+}
+
+@end