Add interfaces and stubs for audio and video tracks
[WebKit-https.git] / Source / WebCore / platform / graphics / AudioTrackPrivate.h
1 /*
2  * Copyright (C) 2012 Apple 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 APPLE COMPUTER, 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 APPLE COMPUTER, 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 AudioTrackPrivate_h
27 #define AudioTrackPrivate_h
28
29 #include <wtf/Forward.h>
30 #include <wtf/Noncopyable.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/text/AtomicString.h>
33
34 #if ENABLE(VIDEO_TRACK)
35
36 namespace WebCore {
37
38 class AudioTrackPrivate;
39
40 class AudioTrackPrivateClient {
41 public:
42     virtual ~AudioTrackPrivateClient() { }
43     virtual void willRemoveAudioTrackPrivate(AudioTrackPrivate*) = 0;
44 };
45
46 class AudioTrackPrivate : public RefCounted<AudioTrackPrivate> {
47     WTF_MAKE_NONCOPYABLE(AudioTrackPrivate); WTF_MAKE_FAST_ALLOCATED;
48 public:
49     static PassRefPtr<AudioTrackPrivate> create()
50     {
51         return adoptRef(new AudioTrackPrivate());
52     }
53     virtual ~AudioTrackPrivate() { }
54
55     void setClient(AudioTrackPrivateClient* client) { m_client = client; }
56     AudioTrackPrivateClient* client() { return m_client; }
57
58     virtual void setEnabled(bool enabled) { m_enabled = enabled; };
59     virtual bool enabled() const { return m_enabled; }
60
61     enum Kind { Alternative, Description, Main, MainDesc, Translation, Commentary, None };
62     virtual Kind kind() const { return None; }
63
64     virtual AtomicString id() const { return emptyAtom; }
65     virtual AtomicString label() const { return emptyAtom; }
66     virtual AtomicString language() const { return emptyAtom; }
67
68     virtual int audioTrackIndex() const { return 0; }
69
70     void willBeRemoved()
71     {
72         if (m_client)
73             m_client->willRemoveAudioTrackPrivate(this);
74     }
75
76 protected:
77     AudioTrackPrivate()
78         : m_enabled(false)
79     {
80     }
81
82 private:
83     AudioTrackPrivateClient* m_client;
84     bool m_enabled;
85 };
86
87 } // namespace WebCore
88
89 #endif
90 #endif