Headers that use WEBCORE_EXPORT should include PlatformExportMacros.h
[WebKit-https.git] / Source / WebCore / html / track / AudioTrack.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2011, 2012, 2013 Apple Inc.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef AudioTrack_h
28 #define AudioTrack_h
29
30 #include "PlatformExportMacros.h"
31
32 #if ENABLE(VIDEO_TRACK)
33
34 #include "AudioTrackPrivate.h"
35 #include "ExceptionCode.h"
36 #include "TrackBase.h"
37 #include <wtf/RefCounted.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 class AudioTrack;
43
44 class AudioTrackClient {
45 public:
46     virtual ~AudioTrackClient() { }
47     virtual void audioTrackEnabledChanged(AudioTrack*) = 0;
48 };
49
50 class AudioTrack final : public TrackBase, public AudioTrackPrivateClient {
51 public:
52     static Ref<AudioTrack> create(AudioTrackClient* client, PassRefPtr<AudioTrackPrivate> trackPrivate)
53     {
54         return adoptRef(*new AudioTrack(client, trackPrivate));
55     }
56     virtual ~AudioTrack();
57
58     static const AtomicString& alternativeKeyword();
59     static const AtomicString& descriptionKeyword();
60     static const AtomicString& mainKeyword();
61     static const AtomicString& mainDescKeyword();
62     static const AtomicString& translationKeyword();
63     static const AtomicString& commentaryKeyword();
64     virtual const AtomicString& defaultKindKeyword() const override { return emptyAtom; }
65
66     virtual bool enabled() const override { return m_enabled; }
67     void setEnabled(const bool);
68
69     virtual void clearClient() override { m_client = nullptr; }
70     AudioTrackClient* client() const { return m_client; }
71
72     size_t inbandTrackIndex();
73
74     void setPrivate(PassRefPtr<AudioTrackPrivate>);
75
76 protected:
77     AudioTrack(AudioTrackClient*, PassRefPtr<AudioTrackPrivate>);
78
79 private:
80     virtual bool isValidKind(const AtomicString&) const override;
81
82     virtual void enabledChanged(AudioTrackPrivate*, bool) override;
83     virtual void idChanged(TrackPrivateBase*, const AtomicString&) override;
84     virtual void labelChanged(TrackPrivateBase*, const AtomicString&) override;
85     virtual void languageChanged(TrackPrivateBase*, const AtomicString&) override;
86     virtual void willRemove(TrackPrivateBase*) override;
87
88     void updateKindFromPrivate();
89
90     bool m_enabled;
91     AudioTrackClient* m_client;
92
93     RefPtr<AudioTrackPrivate> m_private;
94 };
95
96 inline AudioTrack* toAudioTrack(TrackBase* track)
97 {
98     ASSERT_WITH_SECURITY_IMPLICATION(track->type() == TrackBase::AudioTrack);
99     return static_cast<AudioTrack*>(track);
100 }
101
102 } // namespace WebCore
103
104 #endif
105 #endif