summaryrefslogtreecommitdiffstats
path: root/include/drm/DrmSupportInfo.h
blob: bf12b0b37e9dc3bce73bd896e93e1535a1bce8ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __DRM_SUPPORT_INFO_H__
#define __DRM_SUPPORT_INFO_H__

#include "drm_framework_common.h"

namespace android {

/**
 * This is an utility class which wraps the capability of each plug-in,
 * such as mimetype's and file suffixes it could handle.
 *
 * Plug-in developer could return the capability of the plugin by passing
 * DrmSupportInfo instance.
 *
 */
class DrmSupportInfo {
public:
    /**
     * Iterator for mMimeTypeVector
     */
    class MimeTypeIterator {
        friend class DrmSupportInfo;
    private:
        MimeTypeIterator(DrmSupportInfo* drmSupportInfo)
           : mDrmSupportInfo(drmSupportInfo), mIndex(0) {}
    public:
        MimeTypeIterator(const MimeTypeIterator& iterator);
        MimeTypeIterator& operator=(const MimeTypeIterator& iterator);
        virtual ~MimeTypeIterator() {}

    public:
        bool hasNext();
        String8& next();

    private:
        DrmSupportInfo* mDrmSupportInfo;
        unsigned int mIndex;
    };

    /**
     * Iterator for mFileSuffixVector
     */
    class FileSuffixIterator {
       friend class DrmSupportInfo;

    private:
        FileSuffixIterator(DrmSupportInfo* drmSupportInfo)
            : mDrmSupportInfo(drmSupportInfo), mIndex(0) {}
    public:
        FileSuffixIterator(const FileSuffixIterator& iterator);
        FileSuffixIterator& operator=(const FileSuffixIterator& iterator);
        virtual ~FileSuffixIterator() {}

    public:
        bool hasNext();
        String8& next();

    private:
        DrmSupportInfo* mDrmSupportInfo;
        unsigned int mIndex;
    };

public:
    /**
     * Constructor for DrmSupportInfo
     */
    DrmSupportInfo();

    /**
     * Copy constructor for DrmSupportInfo
     */
    DrmSupportInfo(const DrmSupportInfo& drmSupportInfo);

    /**
     * Destructor for DrmSupportInfo
     */
    virtual ~DrmSupportInfo() {}

    DrmSupportInfo& operator=(const DrmSupportInfo& drmSupportInfo);
    bool operator<(const DrmSupportInfo& drmSupportInfo) const;
    bool operator==(const DrmSupportInfo& drmSupportInfo) const;

    /**
     * Returns FileSuffixIterator object to walk through file suffix values
     * associated with this instance
     *
     * @return FileSuffixIterator object
     */
    FileSuffixIterator getFileSuffixIterator();

    /**
     * Returns MimeTypeIterator object to walk through mimetype values
     * associated with this instance
     *
     * @return MimeTypeIterator object
     */
    MimeTypeIterator getMimeTypeIterator();

public:
    /**
     * Returns the number of mimetypes supported.
     *
     * @return Number of mimetypes supported
     */
    int getMimeTypeCount(void) const;

    /**
     * Returns the number of file types supported.
     *
     * @return Number of file types supported
     */
    int getFileSuffixCount(void) const;

    /**
     * Adds the mimetype to the list of supported mimetypes
     *
     * @param[in] mimeType mimetype to be added
     * @return Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure
     */
    status_t addMimeType(const String8& mimeType);

    /**
     * Adds the filesuffix to the list of supported file types
     *
     * @param[in] filesuffix file suffix to be added
     * @return Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure
     */
    status_t addFileSuffix(const String8& fileSuffix);

    /**
     * Set the unique description about the plugin
     *
     * @param[in] description Unique description
     * @return Returns DRM_NO_ERROR for success, DRM_ERROR_UNKNOWN for failure
     */
    status_t setDescription(const String8& description);

    /**
     * Returns the unique description associated with the plugin
     *
     * @return Unique description
     */
    String8 getDescription() const;

    /**
     * Returns whether given mimetype is supported or not
     *
     * @param[in] mimeType MIME type
     * @return
     *        true - if mime-type is supported
     *        false - if mime-type is not supported
     */
    bool isSupportedMimeType(const String8& mimeType) const;

    /**
     * Returns whether given file type is supported or not
     *
     * @param[in] fileType File type
     * @return
     *     true if file type is supported
     *     false if file type is not supported
     */
    bool isSupportedFileSuffix(const String8& fileType) const;

private:
    Vector<String8> mMimeTypeVector;
    Vector<String8> mFileSuffixVector;

    String8 mDescription;
};

};

#endif /* __DRM_SUPPORT_INFO_H__ */