MediaPlayerInterface.h revision 342e9cf388cceb807def720e40e8b0a217f4bcaa
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_MEDIAPLAYERINTERFACE_H 18#define ANDROID_MEDIAPLAYERINTERFACE_H 19 20#ifdef __cplusplus 21 22#include <sys/types.h> 23#include <ui/ISurface.h> 24#include <utils/RefBase.h> 25#include <utils/Errors.h> 26 27#include <media/mediaplayer.h> 28#include <media/AudioSystem.h> 29#include <media/Metadata.h> 30 31namespace android { 32 33class Parcel; 34template<typename T> class SortedVector; 35 36enum player_type { 37 PV_PLAYER = 1, 38 SONIVOX_PLAYER = 2, 39 VORBIS_PLAYER = 3, 40 STAGEFRIGHT_PLAYER = 4, 41 // Test players are available only in the 'test' and 'eng' builds. 42 // The shared library with the test player is passed passed as an 43 // argument to the 'test:' url in the setDataSource call. 44 TEST_PLAYER = 5, 45}; 46 47 48#define DEFAULT_AUDIOSINK_BUFFERCOUNT 4 49#define DEFAULT_AUDIOSINK_BUFFERSIZE 1200 50#define DEFAULT_AUDIOSINK_SAMPLERATE 44100 51 52 53// callback mechanism for passing messages to MediaPlayer object 54typedef void (*notify_callback_f)(void* cookie, int msg, int ext1, int ext2); 55 56// abstract base class - use MediaPlayerInterface 57class MediaPlayerBase : public RefBase 58{ 59public: 60 // AudioSink: abstraction layer for audio output 61 class AudioSink : public RefBase { 62 public: 63 typedef void (*AudioCallback)( 64 AudioSink *audioSink, void *buffer, size_t size, void *cookie); 65 66 virtual ~AudioSink() {} 67 virtual bool ready() const = 0; // audio output is open and ready 68 virtual bool realtime() const = 0; // audio output is real-time output 69 virtual ssize_t bufferSize() const = 0; 70 virtual ssize_t frameCount() const = 0; 71 virtual ssize_t channelCount() const = 0; 72 virtual ssize_t frameSize() const = 0; 73 virtual uint32_t latency() const = 0; 74 virtual float msecsPerFrame() const = 0; 75 virtual status_t getPosition(uint32_t *position) = 0; 76 77 // If no callback is specified, use the "write" API below to submit 78 // audio data. Otherwise return a full buffer of audio data on each 79 // callback. 80 virtual status_t open( 81 uint32_t sampleRate, int channelCount, 82 int format=AudioSystem::PCM_16_BIT, 83 int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT, 84 AudioCallback cb = NULL, 85 void *cookie = NULL) = 0; 86 87 virtual void start() = 0; 88 virtual ssize_t write(const void* buffer, size_t size) = 0; 89 virtual void stop() = 0; 90 virtual void flush() = 0; 91 virtual void pause() = 0; 92 virtual void close() = 0; 93 }; 94 95 MediaPlayerBase() : mCookie(0), mNotify(0) {} 96 virtual ~MediaPlayerBase() {} 97 virtual status_t initCheck() = 0; 98 virtual bool hardwareOutput() = 0; 99 virtual status_t setDataSource(const char *url) = 0; 100 virtual status_t setDataSource(int fd, int64_t offset, int64_t length) = 0; 101 virtual status_t setVideoSurface(const sp<ISurface>& surface) = 0; 102 virtual status_t prepare() = 0; 103 virtual status_t prepareAsync() = 0; 104 virtual status_t start() = 0; 105 virtual status_t stop() = 0; 106 virtual status_t pause() = 0; 107 virtual bool isPlaying() = 0; 108 virtual status_t seekTo(int msec) = 0; 109 virtual status_t getCurrentPosition(int *msec) = 0; 110 virtual status_t getDuration(int *msec) = 0; 111 virtual status_t reset() = 0; 112 virtual status_t setLooping(int loop) = 0; 113 virtual player_type playerType() = 0; 114 virtual void setNotifyCallback(void* cookie, notify_callback_f notifyFunc) { 115 mCookie = cookie; mNotify = notifyFunc; } 116 // Invoke a generic method on the player by using opaque parcels 117 // for the request and reply. 118 // 119 // @param request Parcel that is positioned at the start of the 120 // data sent by the java layer. 121 // @param[out] reply Parcel to hold the reply data. Cannot be null. 122 // @return OK if the call was successful. 123 virtual status_t invoke(const Parcel& request, Parcel *reply) = 0; 124 125 // The Client in the MetadataPlayerService calls this method on 126 // the native player to retrieve all or a subset of metadata. 127 // 128 // @param ids SortedList of metadata ID to be fetch. If empty, all 129 // the known metadata should be returned. 130 // @param[inout] records Parcel where the player appends its metadata. 131 // @return OK if the call was successful. 132 virtual status_t getMetadata(const media::Metadata::Filter& ids, 133 Parcel *records) { 134 return INVALID_OPERATION; 135 }; 136 137 virtual void sendEvent(int msg, int ext1=0, int ext2=0) { if (mNotify) mNotify(mCookie, msg, ext1, ext2); } 138 139protected: 140 void* mCookie; 141 notify_callback_f mNotify; 142}; 143 144// Implement this class for media players that use the AudioFlinger software mixer 145class MediaPlayerInterface : public MediaPlayerBase 146{ 147public: 148 virtual ~MediaPlayerInterface() { } 149 virtual bool hardwareOutput() { return false; } 150 virtual void setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; } 151protected: 152 sp<AudioSink> mAudioSink; 153}; 154 155// Implement this class for media players that output directo to hardware 156class MediaPlayerHWInterface : public MediaPlayerBase 157{ 158public: 159 virtual ~MediaPlayerHWInterface() {} 160 virtual bool hardwareOutput() { return true; } 161 virtual status_t setVolume(float leftVolume, float rightVolume) = 0; 162 virtual status_t setAudioStreamType(int streamType) = 0; 163}; 164 165}; // namespace android 166 167#endif // __cplusplus 168 169 170#endif // ANDROID_MEDIAPLAYERINTERFACE_H 171