/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CachedAudio_h
#define CachedAudio_h

#include "ActiveDOMObject.h"
#include "CachedResource.h"
#include "EventListener.h"
#include "EventTarget.h"
#include "FormData.h"
#include "ResourceResponse.h"
#include <wtf/PassRefPtr.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#include <wtf/text/AtomicStringHash.h>

namespace WebCore {

class AudioBuffer;
class AudioContext;
class Document;

// An audio file resource that is held in the cache.
class CachedAudio : public EventTarget, public CachedResource, public ActiveDOMObject, public RefCounted<CachedAudio> {
public:
    static PassRefPtr<CachedAudio> create(const String& url, AudioContext* context, Document* document, double bufferSampleRate, bool mixToMono);
        
    virtual ~CachedAudio();
    
    void send();

    // CachedResource
    virtual void data(PassRefPtr<SharedBuffer> data, bool allDataReceived);
    virtual void error();
    virtual void didAddClient(CachedResourceClient*);

    // EventTarget
    virtual CachedAudio* toCachedAudioRequest() { return this; }

    // Loading callbacks
    DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
    DEFINE_ATTRIBUTE_EVENT_LISTENER(load);

    // Javascript attributes        
    AudioBuffer* buffer() { return m_buffer.get(); }
    
    virtual void contextDestroyed();
    virtual bool canSuspend() const;
    virtual void stop();

    virtual ScriptExecutionContext* scriptExecutionContext() const;

    // Event listeners
    virtual EventTargetData* eventTargetData();
    virtual EventTargetData* ensureEventTargetData();

    // Reconcile ref/deref which are defined both in RefCounted<CachedAudio> and EventTarget.
    // using CachedAudio::ref;
    // using CachedAudio::deref;

    void ref();
    void deref();
    
private:    
    CachedAudio(const String& url, AudioContext* context, Document* document, double bufferSampleRate, bool mixToMono);

    virtual void refEventTarget();
    virtual void derefEventTarget();

    void dispatchAbortEvent();
    void dispatchErrorEvent();
    void dispatchLoadEvent();

    EventTargetData m_eventTargetData;

    AudioContext* m_context;
    Document* m_document;
    bool m_mixToMono;
    double m_bufferSampleRate;
    RefPtr<AudioBuffer> m_buffer;
};

} // namespace WebCore

#endif