android_defs.h revision 833251ab9e5e59a6ea5ac325122cf3abdf7cd944 
1/*
2 * Copyright (C) 2010 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
18/**
19 * Used to define the mapping from an OpenSL ES or OpenMAX AL object to an Android
20 * media framework object
21 */
22enum AndroidObjectType {
23    INVALID_TYPE                                =-1,
24    // audio player, playing from a URI or FD data source
25    AUDIOPLAYER_FROM_URIFD                      = 0,
26    // audio player, playing PCM buffers in a buffer queue data source
27    AUDIOPLAYER_FROM_PCM_BUFFERQUEUE            = 1,
28    // audio player, playing transport stream packets in an Android buffer queue data source
29    AUDIOPLAYER_FROM_TS_ANDROIDBUFFERQUEUE      = 2,
30    // audio player, decoding from a URI or FD data source to a buffer queue data sink in PCM format
31    AUDIOPLAYER_FROM_URIFD_TO_PCM_BUFFERQUEUE   = 3,
32    // audio video player, playing transport stream packets in an Android buffer queue data source
33    AUDIOVIDEOPLAYER_FROM_TS_ANDROIDBUFFERQUEUE = 4,
34    // audio video player, playing from a URI or FD data source
35    AUDIOVIDEOPLAYER_FROM_URIFD                 = 5,
36    // audio recorder, recording from an input device data source, streamed into a
37    //   PCM buffer queue data sink
38    AUDIORECORDER_FROM_MIC_TO_PCM_BUFFERQUEUE   = 6,
39    // audio player, decoding from an Android buffer queue with ADTS data,
40    //   to a buffer queue data sink in PCM format
41    AUDIOPLAYER_FROM_ADTS_ABQ_TO_PCM_BUFFERQUEUE = 7,
42    NUM_AUDIOPLAYER_MAP_TYPES
43};
44
45
46/**
47 * Used to define the states of the OpenSL ES / OpenMAX AL object initialization and preparation
48 * with regards to the Android-side of the data, in particular as affected by the play state.
49 */
50enum AndroidObjectState {
51    ANDROID_UNINITIALIZED = -1, // never called SetPlayState(PAUSED or PLAYING)
52    ANDROID_PREPARING,          // currently preparing due to first SetPlayState(PAUSED or PLAYING)
53    ANDROID_READY,              // preparation has completed, and will not be attempted again
54    // NUM_ANDROID_STATES       // unused
55};
56
57
58#define ANDROID_DEFAULT_OUTPUT_STREAM_TYPE AUDIO_STREAM_MUSIC
59
60#define PLAYER_FAILURE ((int32_t) android::UNKNOWN_ERROR)
61#define PLAYER_SUCCESS ((int32_t) android::NO_ERROR)
62
63#define PLAYER_FD_FIND_FILE_SIZE ((int64_t)0xFFFFFFFFFFFFFFFFll)
64
65#define MPEG2_TS_BLOCK_SIZE 188
66
67// FIXME separate the cases where we don't need an AudioTrack callback
68typedef struct AudioPlayback_Parameters_struct {
69    int streamType;
70    int sessionId;
71    android::AudioTrack::callback_t trackcb;
72    void* trackcbUser;
73} AudioPlayback_Parameters;
74
75/**
76 * Structure to maintain the set of audio levels about a player
77 */
78typedef struct AndroidAudioLevels_t {
79    /**
80     * Send level to aux effect, there's a single aux bus, so there's a single level
81     */
82    // FIXME not used yet, will be used when supporting effects in OpenMAX AL
83    //SLmillibel mAuxSendLevel;
84    /**
85     * Attenuation factor derived from direct level
86     */
87    // FIXME not used yet, will be used when supporting effects in OpenMAX AL
88    //float mAmplFromDirectLevel;
89    /**
90     * Android Left/Right volume
91     * The final volume of an Android AudioTrack or MediaPlayer is a stereo amplification
92     * (or attenuation) represented as a float from 0.0f to 1.0f
93     */
94    float mFinalVolume[STEREO_CHANNELS];
95} AndroidAudioLevels;
96
97
98/**
99 * Event notification callback from Android to SL ES framework
100 */
101typedef void (*notif_cbf_t)(int event, int data1, int data2, void* notifUser);
102
103/**
104 * Audio data push callback from Android objects to SL ES framework
105 */
106typedef size_t (*data_push_cbf_t)(const uint8_t *data, size_t size, void* user);
107
108
109/**
110 * Events sent to mNotifyClient during prepare, prefetch, and playback
111 * used in APlayer::notify() and AMessage::findxxx()
112 */
113#define PLAYEREVENT_PREPARED                "prep"
114#define PLAYEREVENT_PREFETCHSTATUSCHANGE    "prsc"
115#define PLAYEREVENT_PREFETCHFILLLEVELUPDATE "pflu"
116#define PLAYEREVENT_ENDOFSTREAM             "eos"
117#define PLAYEREVENT_VIDEO_SIZE_UPDATE       "vsiz"
118#define PLAYEREVENT_CHANNEL_COUNT           "ccnt"  // channel count is now known
119#define PLAYEREVENT_PLAY                    "play"  // SL_PLAYEVENT_*
120
121
122/**
123 * Time value when time is unknown. Used for instance for duration or playback position
124 */
125#define ANDROID_UNKNOWN_TIME -1
126
127/**
128 * Event mask for MPEG-2 TS events associated with TS data
129 */
130#define ANDROID_MP2TSEVENT_NONE          ((SLuint32) 0x0)
131// buffer is at End Of Stream
132#define ANDROID_MP2TSEVENT_EOS           ((SLuint32) 0x1)
133// buffer marks a discontinuity with previous TS data, resume display as soon as possible
134#define ANDROID_MP2TSEVENT_DISCONTINUITY ((SLuint32) 0x1 << 1)
135// buffer marks a discontinuity with previous TS data, resume display upon reaching the
136// associated presentation time stamp
137#define ANDROID_MP2TSEVENT_DISCON_NEWPTS ((SLuint32) 0x1 << 2)
138// buffer marks a format change with previous TS data, resume display as soon as possible
139#define ANDROID_MP2TSEVENT_FORMAT_CHANGE ((SLuint32) 0x1 << 3)
140
141/**
142 * Event mask for AAC ADTS events associated with ADTS data
143 */
144#define ANDROID_ADTSEVENT_NONE           ANDROID_MP2TSEVENT_NONE
145// buffer is at End Of Stream
146#define ANDROID_ADTSEVENT_EOS            ANDROID_MP2TSEVENT_EOS
147
148/**
149 * Additional metadata keys
150 *   the ANDROID_KEY_PCMFORMAT_* keys follow the fields of the SLDataFormat_PCM struct, and as such
151 *     all corresponding values match SLuint32 size, and field definitions.
152 * FIXME these values are candidates to be included in OpenSLES_Android.h as official metadata
153 *     keys supported on the platform.
154 */
155#define ANDROID_KEY_PCMFORMAT_NUMCHANNELS   "AndroidPcmFormatNumChannels"
156#define ANDROID_KEY_PCMFORMAT_SAMPLESPERSEC "AndroidPcmFormatSamplesPerSec"
157#define ANDROID_KEY_PCMFORMAT_BITSPERSAMPLE "AndroidPcmFormatBitsPerSample"
158#define ANDROID_KEY_PCMFORMAT_CONTAINERSIZE "AndroidPcmFormatContainerSize"
159#define ANDROID_KEY_PCMFORMAT_CHANNELMASK   "AndroidPcmFormatChannelMask"
160#define ANDROID_KEY_PCMFORMAT_ENDIANNESS    "AndroidPcmFormatEndianness"
161
162/**
163 * Types of buffers stored in Android Buffer Queues, see IAndroidBufferQueue.mBufferType
164 */
165enum AndroidBufferType_type {
166    kAndroidBufferTypeInvalid = ((SLuint16) 0x0),
167    kAndroidBufferTypeMpeg2Ts = ((SLuint16) 0x1),
168    kAndroidBufferTypeAacadts = ((SLuint16) 0x2),
169};
170
171/**
172 * MIME types required for data in Android Buffer Queues
173 */
174#define ANDROID_MIME_MP2TS                     "video/mp2ts"
175// the MIME type used elsewhere in the Android framework for AAC ADTS
176#define ANDROID_MIME_AACADTS_ANDROID_FRAMEWORK "audio/aac-adts"
177// the MIME type applications should use for AAC ADTS
178#define ANDROID_MIME_AACADTS                   "audio/vnd.android.aac-adts"
179
180/**
181 * Notification thresholds relative to content duration in the cache
182 */
183#define DURATION_CACHED_HIGH_MS  30000 // 30s
184#define DURATION_CACHED_MED_MS   10000 // 10s
185#define DURATION_CACHED_LOW_MS    2000 //  2s
186
187
188namespace android {
189
190/**
191 * Prefetch cache status
192 */
193enum CacheStatus_t {
194        kStatusUnknown = -1,
195        kStatusEmpty   = 0,
196        kStatusLow,
197        kStatusIntermediate,
198        kStatusEnough,
199        kStatusHigh
200};
201
202enum {
203    kDataLocatorNone = 'none',
204    kDataLocatorUri  = 'uri',
205    kDataLocatorFd   = 'fd',
206};
207
208struct FdInfo {
209    int fd;
210    int64_t offset;
211    int64_t length;
212    bool mCloseAfterUse;    // whether to close fd after last reference to fd
213};
214
215// TODO currently used by SfPlayer, to replace by DataLocator2
216union DataLocator {
217    char* uri;
218    FdInfo fdi;
219};
220
221union DataLocator2 {
222    const char* uriRef;
223    FdInfo fdi;
224};
225
226} // namespace android
227