Bug 1708422: part 16) Rename `mozInlineSpellChecker::SpellCheckerTimeSlice` to `mozIn...
[gecko.git] / dom / media / MediaMIMETypes.h
blobf36c1c6f53bab8fb130387741aef6d7266ec2041
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
7 #ifndef MediaMIMETypes_h_
8 #define MediaMIMETypes_h_
10 #include "VideoUtils.h"
11 #include "mozilla/Maybe.h"
12 #include "nsString.h"
14 namespace mozilla {
16 namespace dom {
17 struct AudioConfiguration;
18 struct VideoConfiguration;
19 } // namespace dom
21 // Class containing pointing at a media MIME "type/subtype" string literal.
22 // See IsMediaMIMEType for restrictions.
23 // Mainly used to help construct a MediaMIMEType through the statically-checked
24 // MEDIAMIMETYPE macro, or to compare a MediaMIMEType to a literal.
25 class DependentMediaMIMEType {
26 public:
27 // Construction from a literal. Checked in debug builds.
28 // Use MEDIAMIMETYPE macro instead, for static checking.
29 template <size_t N>
30 explicit DependentMediaMIMEType(const char (&aType)[N])
31 : mMIMEType(aType, N - 1) {
32 MOZ_ASSERT(IsMediaMIMEType(aType, N - 1), "Invalid media MIME type");
35 // MIME "type/subtype".
36 const nsDependentCString& AsDependentString() const { return mMIMEType; }
38 private:
39 nsDependentCString mMIMEType;
42 // Instantiate a DependentMediaMIMEType from a literal. Statically checked.
43 #define MEDIAMIMETYPE(LIT) \
44 static_cast<const DependentMediaMIMEType&>([]() { \
45 static_assert(IsMediaMIMEType(LIT), "Invalid media MIME type"); \
46 return DependentMediaMIMEType(LIT); \
47 }())
49 // Class containing only pre-parsed lowercase media MIME type/subtype.
50 class MediaMIMEType {
51 public:
52 // Construction from a DependentMediaMIMEType, with its inherent checks.
53 // Implicit so MEDIAMIMETYPE can be used wherever a MediaMIMEType is expected.
54 MOZ_IMPLICIT MediaMIMEType(const DependentMediaMIMEType& aType)
55 : mMIMEType(aType.AsDependentString()) {}
57 // MIME "type/subtype", always lowercase.
58 const nsCString& AsString() const { return mMIMEType; }
60 // Comparison with DependentMediaMIMEType.
61 // Useful to compare to MEDIAMIMETYPE literals.
62 bool operator==(const DependentMediaMIMEType& aOther) const {
63 return mMIMEType.Equals(aOther.AsDependentString());
65 bool operator!=(const DependentMediaMIMEType& aOther) const {
66 return !mMIMEType.Equals(aOther.AsDependentString());
69 bool operator==(const MediaMIMEType& aOther) const {
70 return mMIMEType.Equals(aOther.mMIMEType);
72 bool operator!=(const MediaMIMEType& aOther) const {
73 return !mMIMEType.Equals(aOther.mMIMEType);
76 // True if type starts with "application/".
77 bool HasApplicationMajorType() const;
78 // True if type starts with "audio/".
79 // Note that some audio content could be stored in a "video/..." container!
80 bool HasAudioMajorType() const;
81 // True if type starts with "video/".
82 // Note that this does not guarantee 100% that the content is actually video!
83 // (e.g., "video/webm" could contain a vorbis audio track.)
84 bool HasVideoMajorType() const;
86 size_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
88 private:
89 friend Maybe<MediaMIMEType> MakeMediaMIMEType(const nsAString& aType);
90 friend class MediaExtendedMIMEType;
91 explicit MediaMIMEType(const nsACString& aType);
93 nsCString mMIMEType; // UTF8 MIME "type/subtype".
96 Maybe<MediaMIMEType> MakeMediaMIMEType(const nsAString& aType);
97 Maybe<MediaMIMEType> MakeMediaMIMEType(const nsACString& aType);
98 Maybe<MediaMIMEType> MakeMediaMIMEType(const char* aType);
100 // A list of case-sensitive codecs attached to a MediaExtendedMIMEType.
101 class MediaCodecs {
102 public:
103 MediaCodecs() = default;
104 // Construction from a comma-separated list of codecs. Unchecked.
105 explicit MediaCodecs(const nsAString& aCodecs) : mCodecs(aCodecs) {}
106 // Construction from a literal comma-separated list of codecs. Unchecked.
107 template <size_t N>
108 explicit MediaCodecs(const char (&aCodecs)[N])
109 : mCodecs(NS_ConvertUTF8toUTF16(aCodecs, N - 1)) {}
111 bool IsEmpty() const { return mCodecs.IsEmpty(); }
112 const nsString& AsString() const { return mCodecs; }
114 using RangeType =
115 const StringListRange<nsString,
116 StringListRangeEmptyItems::ProcessEmptyItems>;
118 // Produces a range object with begin()&end(), can be used in range-for loops.
119 // This will iterate through all codecs, even empty ones (except if the
120 // original list was an empty string). Iterators dereference to
121 // 'const nsDependentString', valid for as long as this MediaCodecs object.
122 RangeType Range() const { return RangeType(mCodecs); };
124 // Does this list of codecs contain the given aCodec?
125 bool Contains(const nsAString& aCodec) const;
126 // Does this list of codecs contain *all* the codecs in the given list?
127 bool ContainsAll(const MediaCodecs& aCodecs) const;
129 // Does this list of codecs contain a codec starting with the given prefix?
130 bool ContainsPrefix(const nsAString& aCodecPrefix) const;
132 template <size_t N>
133 bool operator==(const char (&aType)[N]) const {
134 return mCodecs.EqualsASCII(aType, N - 1);
137 size_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
139 private:
140 // UTF16 comma-separated list of codecs.
141 // See http://www.rfc-editor.org/rfc/rfc4281.txt for the description
142 // of the 'codecs' parameter.
143 nsString mCodecs;
146 // Class containing pre-parsed media MIME type parameters, e.g.:
147 // MIME type/subtype, optional codecs, etc.
148 class MediaExtendedMIMEType {
149 public:
150 explicit MediaExtendedMIMEType(const MediaMIMEType& aType);
151 explicit MediaExtendedMIMEType(MediaMIMEType&& aType);
153 // MIME "type/subtype".
154 const MediaMIMEType& Type() const { return mMIMEType; }
156 // Was there an explicit 'codecs' parameter provided?
157 bool HaveCodecs() const { return mHaveCodecs; }
158 // Codecs. May be empty if not provided or explicitly provided as empty.
159 const MediaCodecs& Codecs() const { return mCodecs; }
161 // Sizes and rates.
162 Maybe<int32_t> GetWidth() const { return GetMaybeNumber(mWidth); }
163 Maybe<int32_t> GetHeight() const { return GetMaybeNumber(mHeight); }
164 Maybe<double> GetFramerate() const { return GetMaybeNumber(mFramerate); }
165 Maybe<int32_t> GetBitrate() const { return GetMaybeNumber(mBitrate); }
166 Maybe<int32_t> GetChannels() const { return GetMaybeNumber(mChannels); }
167 Maybe<int32_t> GetSamplerate() const { return GetMaybeNumber(mSamplerate); }
169 // Original string. Note that "type/subtype" may not be lowercase,
170 // use Type().AsString() instead to get the normalized "type/subtype".
171 const nsCString& OriginalString() const { return mOriginalString; }
173 size_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
175 // aFrac is either a floating-point number or a fraction made of two
176 // floating-point numbers.
177 static Maybe<double> ComputeFractionalString(const nsAString& aFrac);
179 private:
180 friend Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(
181 const nsAString& aType);
182 friend Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(
183 const dom::VideoConfiguration& aConfig);
184 friend Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(
185 const dom::AudioConfiguration& aConfig);
187 MediaExtendedMIMEType(const nsACString& aOriginalString,
188 const nsACString& aMIMEType, bool aHaveCodecs,
189 const nsAString& aCodecs, int32_t aWidth,
190 int32_t aHeight, double aFramerate, int32_t aBitrate);
191 MediaExtendedMIMEType(const nsACString& aOriginalString,
192 const nsACString& aMIMEType, bool aHaveCodecs,
193 const nsAString& aCodecs, int32_t aChannels,
194 int32_t aSamplerate, int32_t aBitrate);
196 template <typename T>
197 Maybe<T> GetMaybeNumber(T aNumber) const {
198 return (aNumber < 0) ? Maybe<T>(Nothing()) : Some(T(aNumber));
201 nsCString mOriginalString; // Original full string.
202 MediaMIMEType mMIMEType; // MIME type/subtype.
203 bool mHaveCodecs = false; // If false, mCodecs must be empty.
204 MediaCodecs mCodecs;
205 // For video
206 int32_t mWidth = -1; // -1 if not provided.
207 int32_t mHeight = -1; // -1 if not provided.
208 double mFramerate = -1; // -1 if not provided.
209 // For audio
210 int32_t mChannels = -1; // -1 if not provided.
211 int32_t mSamplerate = -1; // -1 if not provided.
212 // For both audio and video.
213 int32_t mBitrate = -1; // -1 if not provided.
216 Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(const nsAString& aType);
217 Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(const nsACString& aType);
218 Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(const char* aType);
219 Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(
220 const dom::VideoConfiguration& aConfig);
221 Maybe<MediaExtendedMIMEType> MakeMediaExtendedMIMEType(
222 const dom::AudioConfiguration& aConfig);
224 } // namespace mozilla
226 #endif // MediaMIMETypes_h_