Home | History | Annotate | Download | only in android
      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  */
     22 enum 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  */
     50 enum 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 typedef struct AudioPlayback_Parameters_struct {
     68     int streamType;
     69     int sessionId;
     70 } AudioPlayback_Parameters;
     71 
     72 /**
     73  * Structure to maintain the set of audio levels about a player
     74  */
     75 typedef struct AndroidAudioLevels_t {
     76     /**
     77      * Send level to aux effect, there's a single aux bus, so there's a single level
     78      */
     79     // FIXME not used yet, will be used when supporting effects in OpenMAX AL
     80     //SLmillibel mAuxSendLevel;
     81     /**
     82      * Attenuation factor derived from direct level
     83      */
     84     // FIXME not used yet, will be used when supporting effects in OpenMAX AL
     85     //float mAmplFromDirectLevel;
     86     /**
     87      * Android Left/Right volume
     88      * The final volume of an Android AudioTrack or MediaPlayer is a stereo amplification
     89      * (or attenuation) represented as a float from 0.0f to 1.0f
     90      */
     91     float mFinalVolume[STEREO_CHANNELS];
     92 } AndroidAudioLevels;
     93 
     94 
     95 /**
     96  * Event notification callback from Android to SL ES framework
     97  */
     98 typedef void (*notif_cbf_t)(int event, int data1, int data2, void* notifUser);
     99 
    100 /**
    101  * Audio data push callback from Android objects to SL ES framework
    102  */
    103 typedef size_t (*data_push_cbf_t)(const uint8_t *data, size_t size, CAudioPlayer* ap);
    104 
    105 
    106 /**
    107  * Events sent to mNotifyClient during prepare, prefetch, and playback
    108  * used in APlayer::notify() and AMessage::findxxx()
    109  */
    110 #define PLAYEREVENT_PREPARED                "prep"
    111 #define PLAYEREVENT_PREFETCHSTATUSCHANGE    "prsc"
    112 #define PLAYEREVENT_PREFETCHFILLLEVELUPDATE "pflu"
    113 #define PLAYEREVENT_ENDOFSTREAM             "eos"
    114 #define PLAYEREVENT_VIDEO_SIZE_UPDATE       "vsiz"
    115 #define PLAYEREVENT_CHANNEL_COUNT           "ccnt"  // channel count is now known
    116 #define PLAYEREVENT_PLAY                    "play"  // SL_PLAYEVENT_*
    117 #define PLAYEREVENT_ERRORAFTERPREPARE       "easp"  // error after successful prepare
    118 
    119 
    120 /**
    121  * Time value when time is unknown. Used for instance for duration or playback position
    122  */
    123 #define ANDROID_UNKNOWN_TIME -1
    124 
    125 /**
    126  * Event mask for MPEG-2 TS events associated with TS data
    127  */
    128 #define ANDROID_MP2TSEVENT_NONE          ((SLuint32) 0x0)
    129 // buffer is at End Of Stream
    130 #define ANDROID_MP2TSEVENT_EOS           ((SLuint32) 0x1)
    131 // buffer marks a discontinuity with previous TS data, resume display as soon as possible
    132 #define ANDROID_MP2TSEVENT_DISCONTINUITY ((SLuint32) 0x1 << 1)
    133 // buffer marks a discontinuity with previous TS data, resume display upon reaching the
    134 // associated presentation time stamp
    135 #define ANDROID_MP2TSEVENT_DISCON_NEWPTS ((SLuint32) 0x1 << 2)
    136 // buffer marks a format change with previous TS data, resume display as soon as possible
    137 #define ANDROID_MP2TSEVENT_FORMAT_CHANGE_FULL  ((SLuint32) 0x1 << 3)
    138 #define ANDROID_MP2TSEVENT_FORMAT_CHANGE_VIDEO ((SLuint32) 0x1 << 4)
    139 
    140 /**
    141  * Event mask for AAC ADTS events associated with ADTS data
    142  */
    143 #define ANDROID_ADTSEVENT_NONE           ANDROID_MP2TSEVENT_NONE
    144 // buffer is at End Of Stream
    145 #define ANDROID_ADTSEVENT_EOS            ANDROID_MP2TSEVENT_EOS
    146 
    147 /**
    148  * Types of buffers stored in Android Buffer Queues, see IAndroidBufferQueue.mBufferType
    149  */
    150 enum AndroidBufferType_type {
    151     kAndroidBufferTypeInvalid = ((SLuint16) 0x0),
    152     kAndroidBufferTypeMpeg2Ts = ((SLuint16) 0x1),
    153     kAndroidBufferTypeAacadts = ((SLuint16) 0x2),
    154 };
    155 
    156 /**
    157  * MIME types required for data in Android Buffer Queues
    158  */
    159 // The preferred MIME types for new applications are in ../../include/*/OpenMAXAL_Android.h
    160 // The legacy MIME type used elsewhere in the Android framework for AAC ADTS is below:
    161 #define ANDROID_MIME_AACADTS_ANDROID_FRAMEWORK "audio/aac-adts"
    162 
    163 /**
    164  * Notification thresholds relative to content duration in the cache
    165  */
    166 #define DURATION_CACHED_HIGH_MS  30000 // 30s
    167 #define DURATION_CACHED_MED_MS   10000 // 10s
    168 #define DURATION_CACHED_LOW_MS    2000 //  2s
    169 
    170 
    171 namespace android {
    172 
    173 /**
    174  * Prefetch cache status
    175  */
    176 enum CacheStatus_t {
    177         kStatusUnknown = -1,
    178         kStatusEmpty   = 0,
    179         kStatusLow,
    180         kStatusIntermediate,
    181         kStatusEnough,
    182         kStatusHigh
    183 };
    184 
    185 enum {
    186     kDataLocatorNone = 'none',
    187     kDataLocatorUri  = 'uri',
    188     kDataLocatorFd   = 'fd',
    189 };
    190 
    191 struct FdInfo {
    192     int fd;
    193     int64_t offset;
    194     int64_t length;
    195     bool mCloseAfterUse;    // whether to close fd after last reference to fd
    196 };
    197 
    198 // TODO currently used by SfPlayer, to replace by DataLocator2
    199 union DataLocator {
    200     char* uri;
    201     FdInfo fdi;
    202 };
    203 
    204 union DataLocator2 {
    205     const char* uriRef;
    206     FdInfo fdi;
    207 };
    208 
    209 } // namespace android
    210