Home | History | Annotate | Download | only in media
      1 /*
      2  * Copyright (C) 2007 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 ANDROID_MEDIAPLAYER_H
     18 #define ANDROID_MEDIAPLAYER_H
     19 
     20 #include <arpa/inet.h>
     21 
     22 #include <binder/IMemory.h>
     23 #include <media/IMediaPlayerClient.h>
     24 #include <media/IMediaPlayer.h>
     25 #include <media/IMediaDeathNotifier.h>
     26 #include <media/IStreamSource.h>
     27 
     28 #include <utils/KeyedVector.h>
     29 #include <utils/String8.h>
     30 
     31 class ANativeWindow;
     32 
     33 namespace android {
     34 
     35 class Surface;
     36 class ISurfaceTexture;
     37 
     38 enum media_event_type {
     39     MEDIA_NOP               = 0, // interface test message
     40     MEDIA_PREPARED          = 1,
     41     MEDIA_PLAYBACK_COMPLETE = 2,
     42     MEDIA_BUFFERING_UPDATE  = 3,
     43     MEDIA_SEEK_COMPLETE     = 4,
     44     MEDIA_SET_VIDEO_SIZE    = 5,
     45     MEDIA_TIMED_TEXT        = 99,
     46     MEDIA_ERROR             = 100,
     47     MEDIA_INFO              = 200,
     48 };
     49 
     50 // Generic error codes for the media player framework.  Errors are fatal, the
     51 // playback must abort.
     52 //
     53 // Errors are communicated back to the client using the
     54 // MediaPlayerListener::notify method defined below.
     55 // In this situation, 'notify' is invoked with the following:
     56 //   'msg' is set to MEDIA_ERROR.
     57 //   'ext1' should be a value from the enum media_error_type.
     58 //   'ext2' contains an implementation dependant error code to provide
     59 //          more details. Should default to 0 when not used.
     60 //
     61 // The codes are distributed as follow:
     62 //   0xx: Reserved
     63 //   1xx: Android Player errors. Something went wrong inside the MediaPlayer.
     64 //   2xx: Media errors (e.g Codec not supported). There is a problem with the
     65 //        media itself.
     66 //   3xx: Runtime errors. Some extraordinary condition arose making the playback
     67 //        impossible.
     68 //
     69 enum media_error_type {
     70     // 0xx
     71     MEDIA_ERROR_UNKNOWN = 1,
     72     // 1xx
     73     MEDIA_ERROR_SERVER_DIED = 100,
     74     // 2xx
     75     MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200,
     76     // 3xx
     77 };
     78 
     79 
     80 // Info and warning codes for the media player framework.  These are non fatal,
     81 // the playback is going on but there might be some user visible issues.
     82 //
     83 // Info and warning messages are communicated back to the client using the
     84 // MediaPlayerListener::notify method defined below.  In this situation,
     85 // 'notify' is invoked with the following:
     86 //   'msg' is set to MEDIA_INFO.
     87 //   'ext1' should be a value from the enum media_info_type.
     88 //   'ext2' contains an implementation dependant info code to provide
     89 //          more details. Should default to 0 when not used.
     90 //
     91 // The codes are distributed as follow:
     92 //   0xx: Reserved
     93 //   7xx: Android Player info/warning (e.g player lagging behind.)
     94 //   8xx: Media info/warning (e.g media badly interleaved.)
     95 //
     96 enum media_info_type {
     97     // 0xx
     98     MEDIA_INFO_UNKNOWN = 1,
     99     // The player was started because it was used as the next player for another
    100     // player, which just completed playback
    101     MEDIA_INFO_STARTED_AS_NEXT = 2,
    102     // 7xx
    103     // The video is too complex for the decoder: it can't decode frames fast
    104     // enough. Possibly only the audio plays fine at this stage.
    105     MEDIA_INFO_VIDEO_TRACK_LAGGING = 700,
    106     // MediaPlayer is temporarily pausing playback internally in order to
    107     // buffer more data.
    108     MEDIA_INFO_BUFFERING_START = 701,
    109     // MediaPlayer is resuming playback after filling buffers.
    110     MEDIA_INFO_BUFFERING_END = 702,
    111     // Bandwidth in recent past
    112     MEDIA_INFO_NETWORK_BANDWIDTH = 703,
    113 
    114     // 8xx
    115     // Bad interleaving means that a media has been improperly interleaved or not
    116     // interleaved at all, e.g has all the video samples first then all the audio
    117     // ones. Video is playing but a lot of disk seek may be happening.
    118     MEDIA_INFO_BAD_INTERLEAVING = 800,
    119     // The media is not seekable (e.g live stream).
    120     MEDIA_INFO_NOT_SEEKABLE = 801,
    121     // New media metadata is available.
    122     MEDIA_INFO_METADATA_UPDATE = 802,
    123 
    124     //9xx
    125     MEDIA_INFO_TIMED_TEXT_ERROR = 900,
    126 };
    127 
    128 
    129 
    130 enum media_player_states {
    131     MEDIA_PLAYER_STATE_ERROR        = 0,
    132     MEDIA_PLAYER_IDLE               = 1 << 0,
    133     MEDIA_PLAYER_INITIALIZED        = 1 << 1,
    134     MEDIA_PLAYER_PREPARING          = 1 << 2,
    135     MEDIA_PLAYER_PREPARED           = 1 << 3,
    136     MEDIA_PLAYER_STARTED            = 1 << 4,
    137     MEDIA_PLAYER_PAUSED             = 1 << 5,
    138     MEDIA_PLAYER_STOPPED            = 1 << 6,
    139     MEDIA_PLAYER_PLAYBACK_COMPLETE  = 1 << 7
    140 };
    141 
    142 // Keep KEY_PARAMETER_* in sync with MediaPlayer.java.
    143 // The same enum space is used for both set and get, in case there are future keys that
    144 // can be both set and get.  But as of now, all parameters are either set only or get only.
    145 enum media_parameter_keys {
    146     // Streaming/buffering parameters
    147     KEY_PARAMETER_CACHE_STAT_COLLECT_FREQ_MS = 1100,            // set only
    148 
    149     // Return a Parcel containing a single int, which is the channel count of the
    150     // audio track, or zero for error (e.g. no audio track) or unknown.
    151     KEY_PARAMETER_AUDIO_CHANNEL_COUNT = 1200,                   // get only
    152 
    153     // Playback rate expressed in permille (1000 is normal speed), saved as int32_t, with negative
    154     // values used for rewinding or reverse playback.
    155     KEY_PARAMETER_PLAYBACK_RATE_PERMILLE = 1300,                // set only
    156 };
    157 
    158 // Keep INVOKE_ID_* in sync with MediaPlayer.java.
    159 enum media_player_invoke_ids {
    160     INVOKE_ID_GET_TRACK_INFO = 1,
    161     INVOKE_ID_ADD_EXTERNAL_SOURCE = 2,
    162     INVOKE_ID_ADD_EXTERNAL_SOURCE_FD = 3,
    163     INVOKE_ID_SELECT_TRACK = 4,
    164     INVOKE_ID_UNSELECT_TRACK = 5,
    165     INVOKE_ID_SET_VIDEO_SCALING_MODE = 6,
    166 };
    167 
    168 // Keep MEDIA_TRACK_TYPE_* in sync with MediaPlayer.java.
    169 enum media_track_type {
    170     MEDIA_TRACK_TYPE_UNKNOWN = 0,
    171     MEDIA_TRACK_TYPE_VIDEO = 1,
    172     MEDIA_TRACK_TYPE_AUDIO = 2,
    173     MEDIA_TRACK_TYPE_TIMEDTEXT = 3,
    174 };
    175 
    176 // ----------------------------------------------------------------------------
    177 // ref-counted object for callbacks
    178 class MediaPlayerListener: virtual public RefBase
    179 {
    180 public:
    181     virtual void notify(int msg, int ext1, int ext2, const Parcel *obj) = 0;
    182 };
    183 
    184 class MediaPlayer : public BnMediaPlayerClient,
    185                     public virtual IMediaDeathNotifier
    186 {
    187 public:
    188     MediaPlayer();
    189     ~MediaPlayer();
    190             void            died();
    191             void            disconnect();
    192 
    193             status_t        setDataSource(
    194                     const char *url,
    195                     const KeyedVector<String8, String8> *headers);
    196 
    197             status_t        setDataSource(int fd, int64_t offset, int64_t length);
    198             status_t        setDataSource(const sp<IStreamSource> &source);
    199             status_t        setVideoSurfaceTexture(
    200                                     const sp<ISurfaceTexture>& surfaceTexture);
    201             status_t        setListener(const sp<MediaPlayerListener>& listener);
    202             status_t        prepare();
    203             status_t        prepareAsync();
    204             status_t        start();
    205             status_t        stop();
    206             status_t        pause();
    207             bool            isPlaying();
    208             status_t        getVideoWidth(int *w);
    209             status_t        getVideoHeight(int *h);
    210             status_t        seekTo(int msec);
    211             status_t        getCurrentPosition(int *msec);
    212             status_t        getDuration(int *msec);
    213             status_t        reset();
    214             status_t        setAudioStreamType(audio_stream_type_t type);
    215             status_t        setLooping(int loop);
    216             bool            isLooping();
    217             status_t        setVolume(float leftVolume, float rightVolume);
    218             void            notify(int msg, int ext1, int ext2, const Parcel *obj = NULL);
    219     static  sp<IMemory>     decode(const char* url, uint32_t *pSampleRate, int* pNumChannels, audio_format_t* pFormat);
    220     static  sp<IMemory>     decode(int fd, int64_t offset, int64_t length, uint32_t *pSampleRate, int* pNumChannels, audio_format_t* pFormat);
    221             status_t        invoke(const Parcel& request, Parcel *reply);
    222             status_t        setMetadataFilter(const Parcel& filter);
    223             status_t        getMetadata(bool update_only, bool apply_filter, Parcel *metadata);
    224             status_t        setAudioSessionId(int sessionId);
    225             int             getAudioSessionId();
    226             status_t        setAuxEffectSendLevel(float level);
    227             status_t        attachAuxEffect(int effectId);
    228             status_t        setParameter(int key, const Parcel& request);
    229             status_t        getParameter(int key, Parcel* reply);
    230             status_t        setRetransmitEndpoint(const char* addrString, uint16_t port);
    231             status_t        setNextMediaPlayer(const sp<MediaPlayer>& player);
    232 
    233 private:
    234             void            clear_l();
    235             status_t        seekTo_l(int msec);
    236             status_t        prepareAsync_l();
    237             status_t        getDuration_l(int *msec);
    238             status_t        attachNewPlayer(const sp<IMediaPlayer>& player);
    239             status_t        reset_l();
    240             status_t        doSetRetransmitEndpoint(const sp<IMediaPlayer>& player);
    241 
    242     sp<IMediaPlayer>            mPlayer;
    243     thread_id_t                 mLockThreadId;
    244     Mutex                       mLock;
    245     Mutex                       mNotifyLock;
    246     Condition                   mSignal;
    247     sp<MediaPlayerListener>     mListener;
    248     void*                       mCookie;
    249     media_player_states         mCurrentState;
    250     int                         mDuration;
    251     int                         mCurrentPosition;
    252     int                         mSeekPosition;
    253     bool                        mPrepareSync;
    254     status_t                    mPrepareStatus;
    255     audio_stream_type_t         mStreamType;
    256     bool                        mLoop;
    257     float                       mLeftVolume;
    258     float                       mRightVolume;
    259     int                         mVideoWidth;
    260     int                         mVideoHeight;
    261     int                         mAudioSessionId;
    262     float                       mSendLevel;
    263     struct sockaddr_in          mRetransmitEndpoint;
    264     bool                        mRetransmitEndpointValid;
    265 };
    266 
    267 }; // namespace android
    268 
    269 #endif // ANDROID_MEDIAPLAYER_H
    270