OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef MEDIA_BASE_CDM_PROMISE_H_ | 5 #ifndef MEDIA_BASE_CDM_PROMISE_H_ |
6 #define MEDIA_BASE_CDM_PROMISE_H_ | 6 #define MEDIA_BASE_CDM_PROMISE_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
11 #include "base/callback.h" | 11 #include "base/logging.h" |
12 #include "media/base/media_export.h" | 12 #include "media/base/media_export.h" |
13 #include "media/base/media_keys.h" | 13 #include "media/base/media_keys.h" |
14 | 14 |
15 namespace media { | 15 namespace media { |
16 | 16 |
17 // Interface for promises being resolved/rejected in response to various | 17 // Interface for promises being resolved/rejected in response to various |
18 // session actions. These may be called synchronously or asynchronously. | 18 // session actions. These may be called synchronously or asynchronously. |
19 // The promise must be resolved or rejected exactly once. It is expected that | 19 // The promise must be resolved or rejected exactly once. It is expected that |
20 // the caller free the promise once it is resolved/rejected. | 20 // the caller free the promise once it is resolved/rejected. |
21 // | 21 |
22 // This is only the base class, as parameter to resolve() varies. | 22 // These classes are almost generic, except for the parameters to reject(). If |
| 23 // a generic class for promises is available, this could be changed to use the |
| 24 // generic class as long as the parameters to reject() can be set appropriately. |
| 25 |
| 26 // The base class only has a reject() method and GetResolveParameterType() that |
| 27 // indicates the type of CdmPromiseTemplate. CdmPromiseTemplate<T> adds the |
| 28 // resolve(T) method that is dependent on the type of promise. This base class |
| 29 // is specified so that the promises can be easily saved before passing across |
| 30 // the pepper interface. |
23 class MEDIA_EXPORT CdmPromise { | 31 class MEDIA_EXPORT CdmPromise { |
24 public: | 32 public: |
25 // A superset of media::MediaKeys::Exception for UMA reporting. | |
26 enum ResultCodeForUMA { | |
27 SUCCESS, | |
28 NOT_SUPPORTED_ERROR, | |
29 INVALID_STATE_ERROR, | |
30 INVALID_ACCESS_ERROR, | |
31 QUOTA_EXCEEDED_ERROR, | |
32 UNKNOWN_ERROR, | |
33 CLIENT_ERROR, | |
34 OUTPUT_ERROR, | |
35 NUM_RESULT_CODES | |
36 }; | |
37 | |
38 enum ResolveParameterType { | 33 enum ResolveParameterType { |
39 VOID_TYPE, | 34 VOID_TYPE, |
40 STRING_TYPE, | 35 STRING_TYPE, |
41 KEY_IDS_VECTOR_TYPE | 36 KEY_IDS_VECTOR_TYPE |
42 }; | 37 }; |
43 | 38 |
44 typedef base::Callback<void(MediaKeys::Exception exception_code, | 39 CdmPromise(); |
45 uint32 system_code, | |
46 const std::string& error_message)> | |
47 PromiseRejectedCB; | |
48 | |
49 virtual ~CdmPromise(); | 40 virtual ~CdmPromise(); |
50 | 41 |
51 // Used to indicate that the operation failed. |exception_code| must be | 42 // Used to indicate that the operation failed. |exception_code| must be |
52 // specified. |system_code| is a Key System-specific value for the error | 43 // specified. |system_code| is a Key System-specific value for the error |
53 // that occurred, or 0 if there is no associated status code or such status | 44 // that occurred, or 0 if there is no associated status code or such status |
54 // codes are not supported by the Key System. |error_message| is optional. | 45 // codes are not supported by the Key System. |error_message| is optional. |
55 virtual void reject(MediaKeys::Exception exception_code, | 46 virtual void reject(MediaKeys::Exception exception_code, |
56 uint32 system_code, | 47 uint32 system_code, |
57 const std::string& error_message); | 48 const std::string& error_message) = 0; |
58 | 49 |
59 ResolveParameterType GetResolveParameterType() const { | 50 // Used to determine the template type of CdmPromiseTemplate<T> so that |
60 return parameter_type_; | 51 // saved CdmPromise objects can be cast to the correct templated version. |
| 52 virtual ResolveParameterType GetResolveParameterType() const = 0; |
| 53 |
| 54 private: |
| 55 DISALLOW_COPY_AND_ASSIGN(CdmPromise); |
| 56 }; |
| 57 |
| 58 // For some reason the Windows compiler is not happy with the implementation |
| 59 // of CdmPromiseTemplate being in the .cc file, so moving it here. |
| 60 namespace { |
| 61 |
| 62 template <typename... T> |
| 63 struct CdmPromiseTraits {}; |
| 64 |
| 65 template <> |
| 66 struct CdmPromiseTraits<> { |
| 67 static const CdmPromise::ResolveParameterType kType = CdmPromise::VOID_TYPE; |
| 68 }; |
| 69 |
| 70 template <> |
| 71 struct CdmPromiseTraits<std::string> { |
| 72 static const CdmPromise::ResolveParameterType kType = CdmPromise::STRING_TYPE; |
| 73 }; |
| 74 |
| 75 template <> |
| 76 struct CdmPromiseTraits<KeyIdsVector> { |
| 77 static const CdmPromise::ResolveParameterType kType = |
| 78 CdmPromise::KEY_IDS_VECTOR_TYPE; |
| 79 }; |
| 80 |
| 81 } // namespace |
| 82 |
| 83 // This class adds the resolve(T) method. This class is still an interface, and |
| 84 // is used as the type of promise that gets passed around. |
| 85 template <typename... T> |
| 86 class MEDIA_EXPORT CdmPromiseTemplate : public CdmPromise { |
| 87 public: |
| 88 CdmPromiseTemplate() : is_settled_(false) {} |
| 89 |
| 90 virtual ~CdmPromiseTemplate() { DCHECK(is_settled_); } |
| 91 |
| 92 virtual void resolve(const T&... result) = 0; |
| 93 |
| 94 // CdmPromise implementation. |
| 95 virtual void reject(MediaKeys::Exception exception_code, |
| 96 uint32 system_code, |
| 97 const std::string& error_message) = 0; |
| 98 |
| 99 virtual ResolveParameterType GetResolveParameterType() const override { |
| 100 return CdmPromiseTraits<T...>::kType; |
61 } | 101 } |
62 | 102 |
63 protected: | 103 protected: |
64 explicit CdmPromise(ResolveParameterType parameter_type); | 104 // All implementations must call this method in resolve() and reject() methods |
65 CdmPromise(ResolveParameterType parameter_type, PromiseRejectedCB reject_cb); | 105 // to indicate that the promise has been settled. |
66 | 106 void MarkPromiseSettled() { |
67 // If constructed with a |uma_name| (which must be the name of a | 107 // Promise can only be settled once. |
68 // CdmPromiseResult UMA), CdmPromise will report the promise result (success | 108 DCHECK(!is_settled_); |
69 // or rejection code). | 109 is_settled_ = true; |
70 CdmPromise(ResolveParameterType parameter_type, | 110 } |
71 PromiseRejectedCB reject_cb, | |
72 const std::string& uma_name); | |
73 | |
74 // Called by all resolve()/reject() methods to report the UMA result if | |
75 // applicable, and update |is_pending_|. | |
76 void ReportResultToUMA(ResultCodeForUMA result); | |
77 | |
78 const ResolveParameterType parameter_type_; | |
79 PromiseRejectedCB reject_cb_; | |
80 | |
81 // Keep track of whether the promise hasn't been resolved or rejected yet. | |
82 bool is_pending_; | |
83 | |
84 // UMA name to report result to. | |
85 std::string uma_name_; | |
86 | |
87 DISALLOW_COPY_AND_ASSIGN(CdmPromise); | |
88 }; | |
89 | |
90 template <typename T> | |
91 class MEDIA_EXPORT CdmPromiseTemplate : public CdmPromise { | |
92 public: | |
93 CdmPromiseTemplate(base::Callback<void(const T&)> resolve_cb, | |
94 PromiseRejectedCB rejected_cb); | |
95 CdmPromiseTemplate(base::Callback<void(const T&)> resolve_cb, | |
96 PromiseRejectedCB rejected_cb, | |
97 const std::string& uma_name); | |
98 virtual void resolve(const T& result); | |
99 | |
100 protected: | |
101 // Allow subclasses to completely override the implementation. | |
102 CdmPromiseTemplate(); | |
103 | 111 |
104 private: | 112 private: |
105 base::Callback<void(const T&)> resolve_cb_; | 113 // Keep track of whether the promise has been resolved or rejected yet. |
| 114 bool is_settled_; |
106 | 115 |
107 DISALLOW_COPY_AND_ASSIGN(CdmPromiseTemplate); | 116 DISALLOW_COPY_AND_ASSIGN(CdmPromiseTemplate); |
108 }; | 117 }; |
109 | |
110 // Specialization for no parameter to resolve(). | |
111 template <> | |
112 class MEDIA_EXPORT CdmPromiseTemplate<void> : public CdmPromise { | |
113 public: | |
114 CdmPromiseTemplate(base::Callback<void(void)> resolve_cb, | |
115 PromiseRejectedCB rejected_cb); | |
116 CdmPromiseTemplate(base::Callback<void(void)> resolve_cb, | |
117 PromiseRejectedCB rejected_cb, | |
118 const std::string& uma_name); | |
119 virtual void resolve(); | |
120 | |
121 protected: | |
122 // Allow subclasses to completely override the implementation. | |
123 CdmPromiseTemplate(); | |
124 | |
125 private: | |
126 base::Callback<void(void)> resolve_cb_; | |
127 | |
128 DISALLOW_COPY_AND_ASSIGN(CdmPromiseTemplate); | |
129 }; | |
130 | 118 |
131 } // namespace media | 119 } // namespace media |
132 | 120 |
133 #endif // MEDIA_BASE_CDM_PROMISE_H_ | 121 #endif // MEDIA_BASE_CDM_PROMISE_H_ |
OLD | NEW |