Wasabi ExpressPlay SDK for iOS  1.10
WsbResults.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | Wasabi - Result Codes
4 |
5 | $Id: WsbResults.h 11061 2014-09-30 23:34:13Z ehodzic $
6 | Original author: Julien Boeuf
7 |
8 | This software is provided to you pursuant to your agreement
9 | with Intertrust Technologies Corporation ("Intertrust").
10 | This software may be used only in accordance with the terms
11 | of the agreement.
12 |
13 | Copyright (c) 2005-2014 by Intertrust. All rights reserved.
14 |
15 ****************************************************************/
21 #ifndef _WSB_RESULTS_H_
22 #define _WSB_RESULTS_H_
23 
24 /*----------------------------------------------------------------------
25 | macros
26 +---------------------------------------------------------------------*/
27 #define WSB_SUCCESS 0
28 #define WSB_FAILURE (-1)
29 
30 #define WSB_FAILED(_result) ((_result) != WSB_SUCCESS)
31 #define WSB_SUCCEEDED(_result) ((_result) == WSB_SUCCESS)
32 
33 /*----------------------------------------------------------------------
34 | error code bases
35 +---------------------------------------------------------------------*/
36 #if !defined(WSB_ERROR_BASE)
37 #define WSB_ERROR_BASE (-100000)
38 #endif
39 
40 /* error codes bases for the external API */
41 #define WSB_ERROR_BASE_GENERAL (WSB_ERROR_BASE - 0 )
42 /* general error codes */
43 #define WSB_ERROR_OUT_OF_MEMORY (WSB_ERROR_BASE_GENERAL - 0)
44 #define WSB_ERROR_OUT_OF_RESOURCES (WSB_ERROR_BASE_GENERAL - 1)
45 #define WSB_ERROR_INTERNAL (WSB_ERROR_BASE_GENERAL - 2)
46 #define WSB_ERROR_INVALID_PARAMETERS (WSB_ERROR_BASE_GENERAL - 3)
47 #define WSB_ERROR_INVALID_STATE (WSB_ERROR_BASE_GENERAL - 4)
48 #define WSB_ERROR_NOT_IMPLEMENTED (WSB_ERROR_BASE_GENERAL - 5)
49 #define WSB_ERROR_OUT_OF_RANGE (WSB_ERROR_BASE_GENERAL - 6)
50 #define WSB_ERROR_ACCESS_DENIED (WSB_ERROR_BASE_GENERAL - 7)
51 #define WSB_ERROR_INVALID_SYNTAX (WSB_ERROR_BASE_GENERAL - 8)
52 #define WSB_ERROR_NOT_SUPPORTED (WSB_ERROR_BASE_GENERAL - 9)
53 #define WSB_ERROR_INVALID_FORMAT (WSB_ERROR_BASE_GENERAL - 10)
54 #define WSB_ERROR_NOT_ENOUGH_SPACE (WSB_ERROR_BASE_GENERAL - 11)
55 #define WSB_ERROR_NO_SUCH_ITEM (WSB_ERROR_BASE_GENERAL - 12)
56 #define WSB_ERROR_NO_SUCH_INTERFACE (WSB_ERROR_BASE_GENERAL - 13)
57 #define WSB_ERROR_NOT_AVAILABLE (WSB_ERROR_BASE_GENERAL - 14)
58 #define WSB_ERROR_TIMEOUT (WSB_ERROR_BASE_GENERAL - 15)
59 #define WSB_ERROR_RUNTIME_NOT_INITED (WSB_ERROR_BASE_GENERAL - 16)
60 #define WSB_ERROR_INVALID_PATH (WSB_ERROR_BASE_GENERAL - 17)
61 #define WSB_ERROR_CANNOT_OPEN_FILE (WSB_ERROR_BASE_GENERAL - 18)
62 #define WSB_ERROR_EOS (WSB_ERROR_BASE_GENERAL - 19)
63 #define WSB_ERROR_INCOMPLETE_MEDIA (WSB_ERROR_BASE_GENERAL - 20)
64 #define WSB_ERROR_STREAM_MISSING (WSB_ERROR_BASE_GENERAL - 21)
65 
66 #define WSB_ERROR_BASE_NETWORK (WSB_ERROR_BASE - 60)
67 #define WSB_ERROR_BASE_DRM_PLUGIN (WSB_ERROR_BASE - 100)
68 #define WSB_ERROR_BASE_DOWNLOAD_MANAGER (WSB_ERROR_BASE - 200)
69 #define WSB_ERROR_BASE_METADATA_HELPER (WSB_ERROR_BASE - 300)
70 #define WSB_ERROR_BASE_LICENSE_STORE (WSB_ERROR_BASE - 400)
71 #define WSB_ERROR_BASE_MEDIA_SOURCE_SERVER (WSB_ERROR_BASE - 500)
72 
73 /* network error codes */
74 #define WSB_ERROR_NETWORK_FAILURE (WSB_ERROR_BASE_NETWORK - 0)
75 #define WSB_ERROR_NETWORK_RESOURCE_NOT_FOUND (WSB_ERROR_BASE_NETWORK - 1)
76 #define WSB_ERROR_NETWORK_CONNECTION_REFUSED (WSB_ERROR_BASE_NETWORK - 2)
77 #define WSB_ERROR_NETWORK_DISCONNECTED (WSB_ERROR_BASE_NETWORK - 3)
78 #define WSB_ERROR_NETWORK_HOST_UNKNOWN (WSB_ERROR_BASE_NETWORK - 4)
79 #define WSB_ERROR_NETWORK_PERMISSION_DENIED (WSB_ERROR_BASE_NETWORK - 5)
80 #define WSB_ERROR_NETWORK_SERVER_FAILURE (WSB_ERROR_BASE_NETWORK - 6)
81 #define WSB_ERROR_NETWORK_PROTOCOL_FAILURE (WSB_ERROR_BASE_NETWORK - 7)
82 
83 /* drm error codes */
84 #define WSB_ERROR_BASE_DRM (WSB_ERROR_BASE - 600)
85 #define WSB_ERROR_DRM_INIT (WSB_ERROR_BASE_DRM - 0)
86 #define WSB_ERROR_DRM_NO_LICENSE (WSB_ERROR_BASE_DRM - 1)
87 #define WSB_ERROR_DRM_NO_SILENT_HEADER (WSB_ERROR_BASE_DRM - 2)
88 #define WSB_ERROR_DRM_NO_RENEWAL_URL (WSB_ERROR_BASE_DRM - 3)
89 #define WSB_ERROR_DRM_ACQUIRE_TOKEN (WSB_ERROR_BASE_DRM - 4)
90 #define WSB_ERROR_DRM_PROCESS_TOKEN (WSB_ERROR_BASE_DRM - 5)
91 #define WSB_ERROR_DRM_EVAL_LICENSE (WSB_ERROR_BASE_DRM - 6)
92 #define WSB_ERROR_DRM_DENY_RIGHTS (WSB_ERROR_BASE_DRM - 7)
93 #define WSB_ERROR_DRM_GET_KEY (WSB_ERROR_BASE_DRM - 8)
94 #define WSB_ERROR_DRM_UNHANDLED_CALLBACK (WSB_ERROR_BASE_DRM - 9)
95 #define WSB_ERROR_DRM_UNHANDLED_OBLIGATION (WSB_ERROR_BASE_DRM - 10)
96 #define WSB_ERROR_DRM_CLIENT_SYSTEM_ERROR (WSB_ERROR_BASE_DRM - 11)
97 #define WSB_ERROR_DRM_INVALID_URL (WSB_ERROR_BASE_DRM - 12)
98 #define WSB_ERROR_DRM_SERVER_UNREACHABLE (WSB_ERROR_BASE_DRM - 13)
99 #define WSB_ERROR_DRM_DENIED_BY_SERVER (WSB_ERROR_BASE_DRM - 14)
100 #define WSB_ERROR_DRM_BAD_SERVER_RESPONSE (WSB_ERROR_BASE_DRM - 15)
101 #define WSB_ERROR_DRM_BAD_CONTENT_FORMAT (WSB_ERROR_BASE_DRM - 16)
102 #define WSB_ERROR_DRM_LICENSE_UNSUPPORTED (WSB_ERROR_BASE_DRM - 17)
103 #define WSB_ERROR_DRM_BAD_LICENSE_FORMAT (WSB_ERROR_BASE_DRM - 18)
104 #define WSB_ERROR_DRM_MISSING_CREDENTIALS (WSB_ERROR_BASE_DRM - 19)
105 #define WSB_ERROR_DRM_LICENSE_EXPIRED (WSB_ERROR_BASE_DRM - 20)
106 #define WSB_ERROR_DRM_PLAY_COUNT_EXCEEDED (WSB_ERROR_BASE_DRM - 21)
107 #define WSB_ERROR_DRM_SUBSCRIPTION_EXPIRED (WSB_ERROR_BASE_DRM - 22)
108 #define WSB_ERROR_DRM_UNKNOWN (WSB_ERROR_BASE_DRM - 23)
109 #define WSB_ERROR_DRM_UNSAFE (WSB_ERROR_BASE_DRM - 24)
110 
111 
112 /* directshow filter error code base */
113 #define WSB_ERROR_BASE_DS_FILTER (WSB_ERROR_BASE - 700)
114 
115 /* gstreamer element error code base */
116 #define WSB_ERROR_BASE_GST_ELEMENT (WSB_ERROR_BASE - 800)
117 
118 /* DMZ error codes */
119 #if 0
120 #define WSB_ERROR_BASE_DMZ (WSB_ERROR_BASE - 900)
121 
122 #define WSB_ERROR_DMZ_NO_DMZ_INFO (WSB_ERROR_BASE_DMZ - 0)
123 #define WSB_ERROR_DMZ_INVALID_TRACK_TYPE (WSB_ERROR_BASE_DMZ - 1)
124 #define WSB_ERROR_DMZ_INTERNAL_ERROR (WSB_ERROR_BASE_DMZ - 2)
125 #define WSB_ERROR_DMZ_NO_MP4_FILE (WSB_ERROR_BASE_DMZ - 3)
126 #define WSB_ERROR_DMZ_NO_MOVIE (WSB_ERROR_BASE_DMZ - 4)
127 #define WSB_ERROR_DMZ_NO_AUDIO_TRACK (WSB_ERROR_BASE_DMZ - 5)
128 #define WSB_ERROR_DMZ_NO_VIDEO_TRACK (WSB_ERROR_BASE_DMZ - 6)
129 #define WSB_ERROR_DMZ_MEDIA_SPAN_NOT_FOUND (WSB_ERROR_BASE_DMZ - 7)
130 #define WSB_ERROR_DMZ_MEDIA_ENTRY_NOT_FOUND (WSB_ERROR_BASE_DMZ - 8)
131 #define WSB_ERROR_DMZ_DIGEST_VERIFICATION_FAILURE (WSB_ERROR_BASE_DMZ - 9)
132 #define WSB_ERROR_DMZ_CANNOT_RESOLVE_EXTERNAL_ZONE (WSB_ERROR_BASE_DMZ - 10)
133 #define WSB_ERROR_DMZ_ZONE_RESOLVER_NOT_FOUND (WSB_ERROR_BASE_DMZ - 11)
134 #define WSB_ERROR_DMZ_STORE_OPEN_DB (WSB_ERROR_BASE_DMZ - 12)
135 #define WSB_ERROR_DMZ_STORE_ADD_ENTRY (WSB_ERROR_BASE_DMZ - 13)
136 #define WSB_ERROR_DMZ_STORE_ENTRY_NOT_FOUND (WSB_ERROR_BASE_DMZ - 14)
137 #define WSB_ERROR_DMZ_INVALID_AD_PATH (WSB_ERROR_BASE_DMZ - 15)
138 #define WSB_ERROR_DMZ_ZONE_NOT_FOUND (WSB_ERROR_BASE_DMZ - 16)
139 #define WSB_ERROR_DMZ_MULTIPLE_ZONES (WSB_ERROR_BASE_DMZ - 17)
140 #define WSB_ERROR_DMZ_LICENSE_INVALID (WSB_ERROR_BASE_DMZ - 18)
141 #define WSB_ERROR_DMZ_CONTENT_KEY_LENGTH_INVALID (WSB_ERROR_BASE_DMZ - 19)
142 #define WSB_ERROR_DMZ_AD_FILE_NOT_FOUND (WSB_ERROR_BASE_DMZ - 20)
143 #endif
144 
145 /* Adaptive Streaming (Smth) error codes */
146 #define WSB_ERROR_BASE_SMTH (WSB_ERROR_BASE - 1000)
147 
148 /* Action Result Info error codes */
149 #define WSB_ERROR_BASE_ARI (WSB_ERROR_BASE - 1100)
150 
151 /* Http Live Streaming (Hls) error codes */
152 #define WSB_ERROR_BASE_HLS (WSB_ERROR_BASE - 1200)
153 
154 /* MPEG-Dynamic Adaptive Streaming over HTTP (Dash) error codes */
155 #define WSB_ERROR_BASE_DASH (WSB_ERROR_BASE - 1300)
156 
157 
158 /* standard error codes */
159 /* these are special codes to convey an errno */
160 /* the error code is (WSB_ERROR_BASE_ERRNO - errno) */
161 /* where errno is the positive integer from errno.h */
162 #define WSB_ERROR_BASE_ERRNO (WSB_ERROR_BASE - 2000)
163 #define WSB_ERROR_ERRNO(e) (WSB_ERROR_BASE_ERRNO - (e))
164 
165 #endif /* _WSB_RESULTS_H_ */