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