1/*
2 * Copyright (C) 2013 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GOOGLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef RTCDTMFSender_h
27#define RTCDTMFSender_h
28
29#if ENABLE(MEDIA_STREAM)
30
31#include "ActiveDOMObject.h"
32#include "EventTarget.h"
33#include "RTCDTMFSenderHandlerClient.h"
34#include "Timer.h"
35#include <wtf/RefCounted.h>
36
37namespace WebCore {
38
39class MediaStreamTrack;
40class RTCPeerConnectionHandler;
41class RTCDTMFSenderHandler;
42
43class RTCDTMFSender : public RefCounted<RTCDTMFSender>, public EventTarget, public RTCDTMFSenderHandlerClient, public ActiveDOMObject {
44public:
45    static PassRefPtr<RTCDTMFSender> create(ScriptExecutionContext*, RTCPeerConnectionHandler*, PassRefPtr<MediaStreamTrack>, ExceptionCode&);
46    ~RTCDTMFSender();
47
48    bool canInsertDTMF() const;
49    MediaStreamTrack* track() const;
50    String toneBuffer() const;
51    long duration() const { return m_duration; }
52    long interToneGap() const { return m_interToneGap; }
53
54    void insertDTMF(const String& tones, ExceptionCode&);
55    void insertDTMF(const String& tones, long duration, ExceptionCode&);
56    void insertDTMF(const String& tones, long duration, long interToneGap, ExceptionCode&);
57
58    DEFINE_ATTRIBUTE_EVENT_LISTENER(tonechange);
59
60    // EventTarget
61    virtual const AtomicString& interfaceName() const OVERRIDE;
62    virtual ScriptExecutionContext* scriptExecutionContext() const OVERRIDE;
63
64    // ActiveDOMObject
65    virtual void stop() OVERRIDE;
66
67    using RefCounted<RTCDTMFSender>::ref;
68    using RefCounted<RTCDTMFSender>::deref;
69
70private:
71    RTCDTMFSender(ScriptExecutionContext*, PassRefPtr<MediaStreamTrack>, PassOwnPtr<RTCDTMFSenderHandler>);
72
73    void scheduleDispatchEvent(PassRefPtr<Event>);
74    void scheduledEventTimerFired(Timer<RTCDTMFSender>*);
75
76    // EventTarget
77    virtual EventTargetData* eventTargetData() OVERRIDE;
78    virtual EventTargetData* ensureEventTargetData() OVERRIDE;
79    virtual void refEventTarget() OVERRIDE { ref(); }
80    virtual void derefEventTarget() OVERRIDE { deref(); }
81    EventTargetData m_eventTargetData;
82
83    // RTCDTMFSenderHandlerClient
84    virtual void didPlayTone(const String&) OVERRIDE;
85
86    RefPtr<MediaStreamTrack> m_track;
87    long m_duration;
88    long m_interToneGap;
89
90    OwnPtr<RTCDTMFSenderHandler> m_handler;
91
92    bool m_stopped;
93
94    Timer<RTCDTMFSender> m_scheduledEventTimer;
95    Vector<RefPtr<Event> > m_scheduledEvents;
96};
97
98} // namespace WebCore
99
100#endif // ENABLE(MEDIA_STREAM)
101
102#endif // RTCDTMFSender_h
103