Modernize Track classes' code
[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 #pragma once
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "AudioTrackPrivate.h"
32 #include "ExceptionCode.h"
33 #include "PlatformExportMacros.h"
34 #include "TrackBase.h"
35 #include <wtf/text/WTFString.h>
36
37 namespace WebCore {
38
39 class AudioTrack;
40
41 class AudioTrackClient {
42 public:
43     virtual ~AudioTrackClient() { }
44     virtual void audioTrackEnabledChanged(AudioTrack*) = 0;
45 };
46
47 class AudioTrack final : public MediaTrackBase, public AudioTrackPrivateClient {
48 public:
49     static Ref<AudioTrack> create(AudioTrackClient* client, PassRefPtr<AudioTrackPrivate> trackPrivate)
50     {
51         return adoptRef(*new AudioTrack(client, trackPrivate));
52     }
53     virtual ~AudioTrack();
54
55     static const AtomicString& alternativeKeyword();
56     static const AtomicString& descriptionKeyword();
57     static const AtomicString& mainKeyword();
58     static const AtomicString& mainDescKeyword();
59     static const AtomicString& translationKeyword();
60     static const AtomicString& commentaryKeyword();
61     const AtomicString& defaultKindKeyword() const override { return emptyAtom; }
62
63     bool enabled() const override { return m_enabled; }
64     void setEnabled(const bool);
65
66     void clearClient() override { m_client = nullptr; }
67     AudioTrackClient* client() const { return m_client; }
68
69     size_t inbandTrackIndex();
70
71     void setPrivate(PassRefPtr<AudioTrackPrivate>);
72
73 protected:
74     AudioTrack(AudioTrackClient*, PassRefPtr<AudioTrackPrivate>);
75
76 private:
77     bool isValidKind(const AtomicString&) const override;
78
79     // AudioTrackPrivateClient
80     void enabledChanged(AudioTrackPrivate*, bool) override;
81
82     // TrackPrivateBaseClient
83     void idChanged(TrackPrivateBase*, const AtomicString&) override;
84     void labelChanged(TrackPrivateBase*, const AtomicString&) override;
85     void languageChanged(TrackPrivateBase*, const AtomicString&) override;
86     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 } // namespace WebCore
97
98 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::AudioTrack)
99     static bool isType(const WebCore::TrackBase& track) { return track.type() == WebCore::TrackBase::AudioTrack; }
100 SPECIALIZE_TYPE_TRAITS_END()
101
102 #endif