The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 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 | |
Mathias Agopian | 273d098 | 2009-05-31 19:13:00 -0700 | [diff] [blame] | 20 | #include <utils/Log.h> |
| 21 | #include <utils/threads.h> |
| 22 | #include <utils/List.h> |
| 23 | #include <utils/Errors.h> |
Marco Nelissen | 544ad2b | 2013-11-13 14:18:21 -0800 | [diff] [blame] | 24 | #include <utils/String8.h> |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 25 | #include <pthread.h> |
| 26 | |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 27 | struct dirent; |
| 28 | |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 29 | namespace android { |
| 30 | |
| 31 | class MediaScannerClient; |
| 32 | class StringArray; |
Marco Nelissen | 544ad2b | 2013-11-13 14:18:21 -0800 | [diff] [blame] | 33 | class CharacterEncodingDetector; |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 34 | |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 35 | enum MediaScanResult { |
| 36 | // This file or directory was scanned successfully. |
| 37 | MEDIA_SCAN_RESULT_OK, |
| 38 | // This file or directory was skipped because it was not found, could |
| 39 | // not be opened, was of an unsupported type, or was malfored in some way. |
| 40 | MEDIA_SCAN_RESULT_SKIPPED, |
| 41 | // The scan should be aborted due to a fatal error such as out of memory |
| 42 | // or an exception. |
| 43 | MEDIA_SCAN_RESULT_ERROR, |
| 44 | }; |
| 45 | |
Elliott Hughes | f3e80dd | 2014-06-10 16:55:38 -0700 | [diff] [blame] | 46 | struct MediaAlbumArt { |
| 47 | public: |
| 48 | static MediaAlbumArt *fromData(int32_t size, const void* data); |
| 49 | |
| 50 | static void init(MediaAlbumArt* instance, int32_t size, const void* data); |
| 51 | |
| 52 | MediaAlbumArt *clone(); |
| 53 | |
| 54 | const char *data() { |
| 55 | return &mData[0]; |
| 56 | } |
| 57 | |
| 58 | int32_t size() { |
| 59 | return mSize; |
| 60 | } |
| 61 | |
| 62 | private: |
| 63 | int32_t mSize; |
Elliott Hughes | 4177a19 | 2014-06-12 18:17:11 -0700 | [diff] [blame] | 64 | char mData[]; |
Elliott Hughes | f3e80dd | 2014-06-10 16:55:38 -0700 | [diff] [blame] | 65 | |
| 66 | // You can't construct instances of this class directly because this is a |
| 67 | // variable-sized object passed through the binder. |
| 68 | MediaAlbumArt(); |
| 69 | } __packed; |
| 70 | |
Andreas Huber | 413f523 | 2009-12-03 11:31:19 -0800 | [diff] [blame] | 71 | struct MediaScanner { |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 72 | MediaScanner(); |
Andreas Huber | 413f523 | 2009-12-03 11:31:19 -0800 | [diff] [blame] | 73 | virtual ~MediaScanner(); |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 74 | |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 75 | virtual MediaScanResult processFile( |
| 76 | const char *path, const char *mimeType, MediaScannerClient &client) = 0; |
Andreas Huber | 413f523 | 2009-12-03 11:31:19 -0800 | [diff] [blame] | 77 | |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 78 | virtual MediaScanResult processDirectory( |
| 79 | const char *path, MediaScannerClient &client); |
Andreas Huber | 413f523 | 2009-12-03 11:31:19 -0800 | [diff] [blame] | 80 | |
| 81 | void setLocale(const char *locale); |
| 82 | |
Elliott Hughes | f3e80dd | 2014-06-10 16:55:38 -0700 | [diff] [blame] | 83 | virtual MediaAlbumArt *extractAlbumArt(int fd) = 0; |
Andreas Huber | 413f523 | 2009-12-03 11:31:19 -0800 | [diff] [blame] | 84 | |
| 85 | protected: |
| 86 | const char *locale() const; |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 87 | |
| 88 | private: |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 89 | // current locale (like "ja_JP"), created/destroyed with strdup()/free() |
Andreas Huber | 413f523 | 2009-12-03 11:31:19 -0800 | [diff] [blame] | 90 | char *mLocale; |
Guang Zhu | fb6f034 | 2011-09-07 23:55:27 -0700 | [diff] [blame] | 91 | char *mSkipList; |
| 92 | int *mSkipIndex; |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 93 | |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 94 | MediaScanResult doProcessDirectory( |
| 95 | char *path, int pathRemaining, MediaScannerClient &client, bool noMedia); |
| 96 | MediaScanResult doProcessDirectoryEntry( |
| 97 | char *path, int pathRemaining, MediaScannerClient &client, bool noMedia, |
| 98 | struct dirent* entry, char* fileSpot); |
Guang Zhu | fb6f034 | 2011-09-07 23:55:27 -0700 | [diff] [blame] | 99 | void loadSkipList(); |
| 100 | bool shouldSkipDirectory(char *path); |
| 101 | |
Andreas Huber | 413f523 | 2009-12-03 11:31:19 -0800 | [diff] [blame] | 102 | |
| 103 | MediaScanner(const MediaScanner &); |
| 104 | MediaScanner &operator=(const MediaScanner &); |
| 105 | }; |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 106 | |
| 107 | class MediaScannerClient |
| 108 | { |
| 109 | public: |
Marco Nelissen | f482a41 | 2009-09-03 10:49:55 -0700 | [diff] [blame] | 110 | MediaScannerClient(); |
| 111 | virtual ~MediaScannerClient(); |
| 112 | void setLocale(const char* locale); |
| 113 | void beginFile(); |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 114 | status_t addStringTag(const char* name, const char* value); |
Marco Nelissen | f482a41 | 2009-09-03 10:49:55 -0700 | [diff] [blame] | 115 | void endFile(); |
| 116 | |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 117 | virtual status_t scanFile(const char* path, long long lastModified, |
Mike Lockwood | c5182e3 | 2011-04-24 11:15:09 -0700 | [diff] [blame] | 118 | long long fileSize, bool isDirectory, bool noMedia) = 0; |
Jeff Brown | 7188e55 | 2011-07-20 16:38:43 -0700 | [diff] [blame] | 119 | virtual status_t handleStringTag(const char* name, const char* value) = 0; |
| 120 | virtual status_t setMimeType(const char* mimeType) = 0; |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 121 | |
| 122 | protected: |
Marco Nelissen | 544ad2b | 2013-11-13 14:18:21 -0800 | [diff] [blame] | 123 | // default encoding from MediaScanner::mLocale |
| 124 | String8 mLocale; |
The Android Open Source Project | 89fa4ad | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 125 | }; |
| 126 | |
| 127 | }; // namespace android |
| 128 | |
| 129 | #endif // MEDIASCANNER_H |