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 <utils/Errors.h>
24 #include <utils/KeyedVector.h>
25 #include <utils/String8.h>
26 #include <utils/RefBase.h>
27 
28 #include <media/mediaplayer.h>
29 #include <media/AudioResamplerPublic.h>
30 #include <media/AudioTimestamp.h>
31 #include <media/AVSyncSettings.h>
32 #include <media/BufferingSettings.h>
33 #include <media/Metadata.h>
34 
35 // Fwd decl to make sure everyone agrees that the scope of struct sockaddr_in is
36 // global, and not in android::
37 struct sockaddr_in;
38 
39 namespace android {
40 
41 class DataSource;
42 class Parcel;
43 class Surface;
44 class IGraphicBufferProducer;
45 
46 template<typename T> class SortedVector;
47 
48 enum player_type {
49     STAGEFRIGHT_PLAYER = 3,
50     NU_PLAYER = 4,
51     // Test players are available only in the 'test' and 'eng' builds.
52     // The shared library with the test player is passed passed as an
53     // argument to the 'test:' url in the setDataSource call.
54     TEST_PLAYER = 5,
55 };
56 
57 
58 #define DEFAULT_AUDIOSINK_BUFFERCOUNT 4
59 #define DEFAULT_AUDIOSINK_BUFFERSIZE 1200
60 #define DEFAULT_AUDIOSINK_SAMPLERATE 44100
61 
62 // when the channel mask isn't known, use the channel count to derive a mask in AudioSink::open()
63 #define CHANNEL_MASK_USE_CHANNEL_ORDER 0
64 
65 // duration below which we do not allow deep audio buffering
66 #define AUDIO_SINK_MIN_DEEP_BUFFER_DURATION_US 5000000
67 
68 // abstract base class - use MediaPlayerInterface
69 class MediaPlayerBase : public RefBase
70 {
71 public:
72     // callback mechanism for passing messages to MediaPlayer object
73     class Listener : public RefBase {
74     public:
75         virtual void notify(int msg, int ext1, int ext2, const Parcel *obj) = 0;
~Listener()76         virtual ~Listener() {}
77     };
78 
79     // AudioSink: abstraction layer for audio output
80     class AudioSink : public RefBase {
81     public:
82         enum cb_event_t {
83             CB_EVENT_FILL_BUFFER,   // Request to write more data to buffer.
84             CB_EVENT_STREAM_END,    // Sent after all the buffers queued in AF and HW are played
85                                     // back (after stop is called)
86             CB_EVENT_TEAR_DOWN      // The AudioTrack was invalidated due to use case change:
87                                     // Need to re-evaluate offloading options
88         };
89 
90         // Callback returns the number of bytes actually written to the buffer.
91         typedef size_t (*AudioCallback)(
92                 AudioSink *audioSink, void *buffer, size_t size, void *cookie,
93                         cb_event_t event);
94 
~AudioSink()95         virtual             ~AudioSink() {}
96         virtual bool        ready() const = 0; // audio output is open and ready
97         virtual ssize_t     bufferSize() const = 0;
98         virtual ssize_t     frameCount() const = 0;
99         virtual ssize_t     channelCount() const = 0;
100         virtual ssize_t     frameSize() const = 0;
101         virtual uint32_t    latency() const = 0;
102         virtual float       msecsPerFrame() const = 0;
103         virtual status_t    getPosition(uint32_t *position) const = 0;
104         virtual status_t    getTimestamp(AudioTimestamp &ts) const = 0;
105         virtual int64_t     getPlayedOutDurationUs(int64_t nowUs) const = 0;
106         virtual status_t    getFramesWritten(uint32_t *frameswritten) const = 0;
107         virtual audio_session_t getSessionId() const = 0;
108         virtual audio_stream_type_t getAudioStreamType() const = 0;
109         virtual uint32_t    getSampleRate() const = 0;
110         virtual int64_t     getBufferDurationInUs() const = 0;
111 
112         // If no callback is specified, use the "write" API below to submit
113         // audio data.
114         virtual status_t    open(
115                 uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
116                 audio_format_t format=AUDIO_FORMAT_PCM_16_BIT,
117                 int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT,
118                 AudioCallback cb = NULL,
119                 void *cookie = NULL,
120                 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
121                 const audio_offload_info_t *offloadInfo = NULL,
122                 bool doNotReconnect = false,
123                 uint32_t suggestedFrameCount = 0) = 0;
124 
125         virtual status_t    start() = 0;
126 
127         /* Input parameter |size| is in byte units stored in |buffer|.
128          * Data is copied over and actual number of bytes written (>= 0)
129          * is returned, or no data is copied and a negative status code
130          * is returned (even when |blocking| is true).
131          * When |blocking| is false, AudioSink will immediately return after
132          * part of or full |buffer| is copied over.
133          * When |blocking| is true, AudioSink will wait to copy the entire
134          * buffer, unless an error occurs or the copy operation is
135          * prematurely stopped.
136          */
137         virtual ssize_t     write(const void* buffer, size_t size, bool blocking = true) = 0;
138 
139         virtual void        stop() = 0;
140         virtual void        flush() = 0;
141         virtual void        pause() = 0;
142         virtual void        close() = 0;
143 
144         virtual status_t    setPlaybackRate(const AudioPlaybackRate& rate) = 0;
145         virtual status_t    getPlaybackRate(AudioPlaybackRate* rate /* nonnull */) = 0;
needsTrailingPadding()146         virtual bool        needsTrailingPadding() { return true; }
147 
setParameters(const String8 &)148         virtual status_t    setParameters(const String8& /* keyValuePairs */) { return NO_ERROR; }
getParameters(const String8 &)149         virtual String8     getParameters(const String8& /* keys */) { return String8::empty(); }
150 
151         virtual media::VolumeShaper::Status applyVolumeShaper(
152                                     const sp<media::VolumeShaper::Configuration>& configuration,
153                                     const sp<media::VolumeShaper::Operation>& operation) = 0;
154         virtual sp<media::VolumeShaper::State> getVolumeShaperState(int id) = 0;
155 
156         // AudioRouting
157         virtual status_t    setOutputDevice(audio_port_handle_t deviceId) = 0;
158         virtual status_t    getRoutedDeviceId(audio_port_handle_t* deviceId) = 0;
159         virtual status_t    enableAudioDeviceCallback(bool enabled) = 0;
160     };
161 
MediaPlayerBase()162                         MediaPlayerBase() {}
~MediaPlayerBase()163     virtual             ~MediaPlayerBase() {}
164     virtual status_t    initCheck() = 0;
165     virtual bool        hardwareOutput() = 0;
166 
setUID(uid_t)167     virtual status_t    setUID(uid_t /* uid */) {
168         return INVALID_OPERATION;
169     }
170 
171     virtual status_t    setDataSource(
172             const sp<IMediaHTTPService> &httpService,
173             const char *url,
174             const KeyedVector<String8, String8> *headers = NULL) = 0;
175 
176     virtual status_t    setDataSource(int fd, int64_t offset, int64_t length) = 0;
177 
setDataSource(const sp<IStreamSource> &)178     virtual status_t    setDataSource(const sp<IStreamSource>& /* source */) {
179         return INVALID_OPERATION;
180     }
181 
setDataSource(const sp<DataSource> &)182     virtual status_t    setDataSource(const sp<DataSource>& /* source */) {
183         return INVALID_OPERATION;
184     }
185 
186     // pass the buffered IGraphicBufferProducer to the media player service
187     virtual status_t    setVideoSurfaceTexture(
188                                 const sp<IGraphicBufferProducer>& bufferProducer) = 0;
189 
getBufferingSettings(BufferingSettings * buffering)190     virtual status_t    getBufferingSettings(
191                                 BufferingSettings* buffering /* nonnull */) {
192         *buffering = BufferingSettings();
193         return OK;
194     }
setBufferingSettings(const BufferingSettings &)195     virtual status_t    setBufferingSettings(const BufferingSettings& /* buffering */) {
196         return OK;
197     }
198 
199     virtual status_t    prepare() = 0;
200     virtual status_t    prepareAsync() = 0;
201     virtual status_t    start() = 0;
202     virtual status_t    stop() = 0;
203     virtual status_t    pause() = 0;
204     virtual bool        isPlaying() = 0;
setPlaybackSettings(const AudioPlaybackRate & rate)205     virtual status_t    setPlaybackSettings(const AudioPlaybackRate& rate) {
206         // by default, players only support setting rate to the default
207         if (!isAudioPlaybackRateEqual(rate, AUDIO_PLAYBACK_RATE_DEFAULT)) {
208             return BAD_VALUE;
209         }
210         return OK;
211     }
getPlaybackSettings(AudioPlaybackRate * rate)212     virtual status_t    getPlaybackSettings(AudioPlaybackRate* rate /* nonnull */) {
213         *rate = AUDIO_PLAYBACK_RATE_DEFAULT;
214         return OK;
215     }
setSyncSettings(const AVSyncSettings & sync,float)216     virtual status_t    setSyncSettings(const AVSyncSettings& sync, float /* videoFps */) {
217         // By default, players only support setting sync source to default; all other sync
218         // settings are ignored. There is no requirement for getters to return set values.
219         if (sync.mSource != AVSYNC_SOURCE_DEFAULT) {
220             return BAD_VALUE;
221         }
222         return OK;
223     }
getSyncSettings(AVSyncSettings * sync,float * videoFps)224     virtual status_t    getSyncSettings(
225                                 AVSyncSettings* sync /* nonnull */, float* videoFps /* nonnull */) {
226         *sync = AVSyncSettings();
227         *videoFps = -1.f;
228         return OK;
229     }
230     virtual status_t    seekTo(
231             int msec, MediaPlayerSeekMode mode = MediaPlayerSeekMode::SEEK_PREVIOUS_SYNC) = 0;
232     virtual status_t    getCurrentPosition(int *msec) = 0;
233     virtual status_t    getDuration(int *msec) = 0;
234     virtual status_t    reset() = 0;
notifyAt(int64_t)235     virtual status_t    notifyAt(int64_t /* mediaTimeUs */) {
236         return INVALID_OPERATION;
237     }
238     virtual status_t    setLooping(int loop) = 0;
239     virtual player_type playerType() = 0;
240     virtual status_t    setParameter(int key, const Parcel &request) = 0;
241     virtual status_t    getParameter(int key, Parcel *reply) = 0;
242 
243     // default no-op implementation of optional extensions
setRetransmitEndpoint(const struct sockaddr_in *)244     virtual status_t setRetransmitEndpoint(const struct sockaddr_in* /* endpoint */) {
245         return INVALID_OPERATION;
246     }
getRetransmitEndpoint(struct sockaddr_in *)247     virtual status_t getRetransmitEndpoint(struct sockaddr_in* /* endpoint */) {
248         return INVALID_OPERATION;
249     }
setNextPlayer(const sp<MediaPlayerBase> &)250     virtual status_t setNextPlayer(const sp<MediaPlayerBase>& /* next */) {
251         return OK;
252     }
253 
254     // Invoke a generic method on the player by using opaque parcels
255     // for the request and reply.
256     //
257     // @param request Parcel that is positioned at the start of the
258     //                data sent by the java layer.
259     // @param[out] reply Parcel to hold the reply data. Cannot be null.
260     // @return OK if the call was successful.
261     virtual status_t    invoke(const Parcel& request, Parcel *reply) = 0;
262 
263     // The Client in the MetadataPlayerService calls this method on
264     // the native player to retrieve all or a subset of metadata.
265     //
266     // @param ids SortedList of metadata ID to be fetch. If empty, all
267     //            the known metadata should be returned.
268     // @param[inout] records Parcel where the player appends its metadata.
269     // @return OK if the call was successful.
getMetadata(const media::Metadata::Filter &,Parcel *)270     virtual status_t    getMetadata(const media::Metadata::Filter& /* ids */,
271                                     Parcel* /* records */) {
272         return INVALID_OPERATION;
273     };
274 
setNotifyCallback(const sp<Listener> & listener)275     void        setNotifyCallback(
276             const sp<Listener> &listener) {
277         Mutex::Autolock autoLock(mNotifyLock);
278         mListener = listener;
279     }
280 
281     void        sendEvent(int msg, int ext1=0, int ext2=0,
282                           const Parcel *obj=NULL) {
283         sp<Listener> listener;
284         {
285             Mutex::Autolock autoLock(mNotifyLock);
286             listener = mListener;
287         }
288 
289         if (listener != NULL) {
290             listener->notify(msg, ext1, ext2, obj);
291         }
292     }
293 
dump(int,const Vector<String16> &)294     virtual status_t dump(int /* fd */, const Vector<String16>& /* args */) const {
295         return INVALID_OPERATION;
296     }
297 
298     // Modular DRM
prepareDrm(const uint8_t[16],const Vector<uint8_t> &)299     virtual status_t prepareDrm(const uint8_t /* uuid */[16], const Vector<uint8_t>& /* drmSessionId */) {
300         return INVALID_OPERATION;
301     }
releaseDrm()302     virtual status_t releaseDrm() {
303         return INVALID_OPERATION;
304     }
305 
306 private:
307     friend class MediaPlayerService;
308 
309     Mutex               mNotifyLock;
310     sp<Listener>        mListener;
311 };
312 
313 // Implement this class for media players that use the AudioFlinger software mixer
314 class MediaPlayerInterface : public MediaPlayerBase
315 {
316 public:
~MediaPlayerInterface()317     virtual             ~MediaPlayerInterface() { }
hardwareOutput()318     virtual bool        hardwareOutput() { return false; }
setAudioSink(const sp<AudioSink> & audioSink)319     virtual void        setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; }
320 protected:
321     sp<AudioSink>       mAudioSink;
322 };
323 
324 // Implement this class for media players that output audio directly to hardware
325 class MediaPlayerHWInterface : public MediaPlayerBase
326 {
327 public:
~MediaPlayerHWInterface()328     virtual             ~MediaPlayerHWInterface() {}
hardwareOutput()329     virtual bool        hardwareOutput() { return true; }
330     virtual status_t    setVolume(float leftVolume, float rightVolume) = 0;
331     virtual status_t    setAudioStreamType(audio_stream_type_t streamType) = 0;
332 };
333 
334 }; // namespace android
335 
336 #endif // __cplusplus
337 
338 
339 #endif // ANDROID_MEDIAPLAYERINTERFACE_H
340