Home | History | Annotate | Download | only in media
      1 /*
      2  * Copyright (C) 2008 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_IMEDIAPLAYER_H
     18 #define ANDROID_IMEDIAPLAYER_H
     19 
     20 #include <utils/RefBase.h>
     21 #include <binder/IInterface.h>
     22 #include <binder/Parcel.h>
     23 #include <utils/KeyedVector.h>
     24 #include <system/audio.h>
     25 
     26 // Fwd decl to make sure everyone agrees that the scope of struct sockaddr_in is
     27 // global, and not in android::
     28 struct sockaddr_in;
     29 
     30 namespace android {
     31 
     32 class Parcel;
     33 class Surface;
     34 class IDataSource;
     35 struct IStreamSource;
     36 class IGraphicBufferProducer;
     37 struct IMediaHTTPService;
     38 struct AudioPlaybackRate;
     39 struct AVSyncSettings;
     40 
     41 class IMediaPlayer: public IInterface
     42 {
     43 public:
     44     DECLARE_META_INTERFACE(MediaPlayer);
     45 
     46     virtual void            disconnect() = 0;
     47 
     48     virtual status_t        setDataSource(
     49             const sp<IMediaHTTPService> &httpService,
     50             const char *url,
     51             const KeyedVector<String8, String8>* headers) = 0;
     52 
     53     virtual status_t        setDataSource(int fd, int64_t offset, int64_t length) = 0;
     54     virtual status_t        setDataSource(const sp<IStreamSource>& source) = 0;
     55     virtual status_t        setDataSource(const sp<IDataSource>& source) = 0;
     56     virtual status_t        setVideoSurfaceTexture(
     57                                     const sp<IGraphicBufferProducer>& bufferProducer) = 0;
     58     virtual status_t        prepareAsync() = 0;
     59     virtual status_t        start() = 0;
     60     virtual status_t        stop() = 0;
     61     virtual status_t        pause() = 0;
     62     virtual status_t        isPlaying(bool* state) = 0;
     63     virtual status_t        setPlaybackSettings(const AudioPlaybackRate& rate) = 0;
     64     virtual status_t        getPlaybackSettings(AudioPlaybackRate* rate /* nonnull */) = 0;
     65     virtual status_t        setSyncSettings(const AVSyncSettings& sync, float videoFpsHint) = 0;
     66     virtual status_t        getSyncSettings(AVSyncSettings* sync /* nonnull */,
     67                                             float* videoFps /* nonnull */) = 0;
     68     virtual status_t        seekTo(int msec) = 0;
     69     virtual status_t        getCurrentPosition(int* msec) = 0;
     70     virtual status_t        getDuration(int* msec) = 0;
     71     virtual status_t        reset() = 0;
     72     virtual status_t        setAudioStreamType(audio_stream_type_t type) = 0;
     73     virtual status_t        setLooping(int loop) = 0;
     74     virtual status_t        setVolume(float leftVolume, float rightVolume) = 0;
     75     virtual status_t        setAuxEffectSendLevel(float level) = 0;
     76     virtual status_t        attachAuxEffect(int effectId) = 0;
     77     virtual status_t        setParameter(int key, const Parcel& request) = 0;
     78     virtual status_t        getParameter(int key, Parcel* reply) = 0;
     79     virtual status_t        setRetransmitEndpoint(const struct sockaddr_in* endpoint) = 0;
     80     virtual status_t        getRetransmitEndpoint(struct sockaddr_in* endpoint) = 0;
     81     virtual status_t        setNextPlayer(const sp<IMediaPlayer>& next) = 0;
     82 
     83     // Invoke a generic method on the player by using opaque parcels
     84     // for the request and reply.
     85     // @param request Parcel that must start with the media player
     86     // interface token.
     87     // @param[out] reply Parcel to hold the reply data. Cannot be null.
     88     // @return OK if the invocation was made successfully.
     89     virtual status_t        invoke(const Parcel& request, Parcel *reply) = 0;
     90 
     91     // Set a new metadata filter.
     92     // @param filter A set of allow and drop rules serialized in a Parcel.
     93     // @return OK if the invocation was made successfully.
     94     virtual status_t        setMetadataFilter(const Parcel& filter) = 0;
     95 
     96     // Retrieve a set of metadata.
     97     // @param update_only Include only the metadata that have changed
     98     //                    since the last invocation of getMetadata.
     99     //                    The set is built using the unfiltered
    100     //                    notifications the native player sent to the
    101     //                    MediaPlayerService during that period of
    102     //                    time. If false, all the metadatas are considered.
    103     // @param apply_filter If true, once the metadata set has been built based
    104     //                     on the value update_only, the current filter is
    105     //                     applied.
    106     // @param[out] metadata On exit contains a set (possibly empty) of metadata.
    107     //                      Valid only if the call returned OK.
    108     // @return OK if the invocation was made successfully.
    109     virtual status_t        getMetadata(bool update_only,
    110                                         bool apply_filter,
    111                                         Parcel *metadata) = 0;
    112 };
    113 
    114 // ----------------------------------------------------------------------------
    115 
    116 class BnMediaPlayer: public BnInterface<IMediaPlayer>
    117 {
    118 public:
    119     virtual status_t    onTransact( uint32_t code,
    120                                     const Parcel& data,
    121                                     Parcel* reply,
    122                                     uint32_t flags = 0);
    123 };
    124 
    125 }; // namespace android
    126 
    127 #endif // ANDROID_IMEDIAPLAYER_H
    128