mediascanner.h revision 4177a19769d43980bdb803bce33f9cacc1e4e1f8 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef MEDIASCANNER_H
18#define MEDIASCANNER_H
19
20#include <utils/Log.h>
21#include <utils/threads.h>
22#include <utils/List.h>
23#include <utils/Errors.h>
24#include <pthread.h>
25
26struct dirent;
27
28namespace android {
29
30class MediaScannerClient;
31class StringArray;
32
33enum MediaScanResult {
34    // This file or directory was scanned successfully.
35    MEDIA_SCAN_RESULT_OK,
36    // This file or directory was skipped because it was not found, could
37    // not be opened, was of an unsupported type, or was malfored in some way.
38    MEDIA_SCAN_RESULT_SKIPPED,
39    // The scan should be aborted due to a fatal error such as out of memory
40    // or an exception.
41    MEDIA_SCAN_RESULT_ERROR,
42};
43
44struct MediaAlbumArt {
45public:
46    static MediaAlbumArt *fromData(int32_t size, const void* data);
47
48    static void init(MediaAlbumArt* instance, int32_t size, const void* data);
49
50    MediaAlbumArt *clone();
51
52    const char *data() {
53        return &mData[0];
54    }
55
56    int32_t size() {
57        return mSize;
58    }
59
60private:
61    int32_t mSize;
62    char mData[];
63
64    // You can't construct instances of this class directly because this is a
65    // variable-sized object passed through the binder.
66    MediaAlbumArt();
67} __packed;
68
69struct MediaScanner {
70    MediaScanner();
71    virtual ~MediaScanner();
72
73    virtual MediaScanResult processFile(
74            const char *path, const char *mimeType, MediaScannerClient &client) = 0;
75
76    virtual MediaScanResult processDirectory(
77            const char *path, MediaScannerClient &client);
78
79    void setLocale(const char *locale);
80
81    virtual MediaAlbumArt *extractAlbumArt(int fd) = 0;
82
83protected:
84    const char *locale() const;
85
86private:
87    // current locale (like "ja_JP"), created/destroyed with strdup()/free()
88    char *mLocale;
89    char *mSkipList;
90    int *mSkipIndex;
91
92    MediaScanResult doProcessDirectory(
93            char *path, int pathRemaining, MediaScannerClient &client, bool noMedia);
94    MediaScanResult doProcessDirectoryEntry(
95            char *path, int pathRemaining, MediaScannerClient &client, bool noMedia,
96            struct dirent* entry, char* fileSpot);
97    void loadSkipList();
98    bool shouldSkipDirectory(char *path);
99
100
101    MediaScanner(const MediaScanner &);
102    MediaScanner &operator=(const MediaScanner &);
103};
104
105class MediaScannerClient
106{
107public:
108    MediaScannerClient();
109    virtual ~MediaScannerClient();
110    void setLocale(const char* locale);
111    void beginFile();
112    status_t addStringTag(const char* name, const char* value);
113    void endFile();
114
115    virtual status_t scanFile(const char* path, long long lastModified,
116            long long fileSize, bool isDirectory, bool noMedia) = 0;
117    virtual status_t handleStringTag(const char* name, const char* value) = 0;
118    virtual status_t setMimeType(const char* mimeType) = 0;
119
120protected:
121    void convertValues(uint32_t encoding);
122
123protected:
124    // cached name and value strings, for native encoding support.
125    StringArray*    mNames;
126    StringArray*    mValues;
127
128    // default encoding based on MediaScanner::mLocale string
129    uint32_t        mLocaleEncoding;
130};
131
132}; // namespace android
133
134#endif // MEDIASCANNER_H
135