MediaSource.h revision cfd55579c2e20514b181809dfaf30bd6f7e04c7e
1e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber/* 2e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * Copyright (C) 2009 The Android Open Source Project 3e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * 4e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * Licensed under the Apache License, Version 2.0 (the "License"); 5e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * you may not use this file except in compliance with the License. 6e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * You may obtain a copy of the License at 7e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * 8e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * http://www.apache.org/licenses/LICENSE-2.0 9e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * 10e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * Unless required by applicable law or agreed to in writing, software 11e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * distributed under the License is distributed on an "AS IS" BASIS, 12e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * See the License for the specific language governing permissions and 14e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber * limitations under the License. 15e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber */ 16e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 17e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber#ifndef MEDIA_SOURCE_H_ 18e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 19e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber#define MEDIA_SOURCE_H_ 20e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 21e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber#include <sys/types.h> 22e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 23e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber#include <utils/RefBase.h> 24e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 25e46b7be812d68e49710b34048662cbf18e2a6550Andreas Hubernamespace android { 26e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 27e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huberclass MediaBuffer; 28e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huberclass MetaData; 29e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 30be06d26cdc70070654f1eedcd08c1c68cd587ad6Andreas Huberstruct MediaSource : public RefBase { 31e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber MediaSource(); 32e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 33e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // To be called before any other methods on this object, except 34e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // getFormat(). 35e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber virtual status_t start(MetaData *params = NULL) = 0; 36e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 37e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // Any blocking read call returns immediately with a result of NO_INIT. 38e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // It is an error to call any methods other than start after this call 39e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // returns. Any buffers the object may be holding onto at the time of 40e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // the stop() call are released. 41e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // Also, it is imperative that any buffers output by this object and 42e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // held onto by callers be released before a call to stop() !!! 43e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber virtual status_t stop() = 0; 44e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 45e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // Returns the format of the data output by this media source. 46e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber virtual sp<MetaData> getFormat() = 0; 47e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 48e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber struct ReadOptions; 49e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 50e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // Returns a new buffer of data. Call blocks until a 51e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // buffer is available, an error is encountered of the end of the stream 52e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // is reached. 53e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // End of stream is signalled by a result of ERROR_END_OF_STREAM. 54cfd55579c2e20514b181809dfaf30bd6f7e04c7eAndreas Huber // A result of INFO_FORMAT_CHANGED indicates that the format of this 55cfd55579c2e20514b181809dfaf30bd6f7e04c7eAndreas Huber // MediaSource has changed mid-stream, the client can continue reading 56cfd55579c2e20514b181809dfaf30bd6f7e04c7eAndreas Huber // but should be prepared for buffers of the new configuration. 57e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber virtual status_t read( 58e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber MediaBuffer **buffer, const ReadOptions *options = NULL) = 0; 59e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 60e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // Options that modify read() behaviour. The default is to 61e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // a) not request a seek 62e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // b) not be late, i.e. lateness_us = 0 63e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber struct ReadOptions { 64e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber ReadOptions(); 65e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 66e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber // Reset everything back to defaults. 67e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber void reset(); 68e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 69e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber void setSeekTo(int64_t time_us); 70e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber void clearSeekTo(); 71e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber bool getSeekTo(int64_t *time_us) const; 72e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 73e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber void setLateBy(int64_t lateness_us); 74e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber int64_t getLateBy() const; 75e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 76e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber private: 77e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber enum Options { 78e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber kSeekTo_Option = 1, 79e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber }; 80e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 81e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber uint32_t mOptions; 82e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber int64_t mSeekTimeUs; 83e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber int64_t mLatenessUs; 84e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber }; 85e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 86be06d26cdc70070654f1eedcd08c1c68cd587ad6Andreas Huberprotected: 87be06d26cdc70070654f1eedcd08c1c68cd587ad6Andreas Huber virtual ~MediaSource(); 88be06d26cdc70070654f1eedcd08c1c68cd587ad6Andreas Huber 89e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huberprivate: 90e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber MediaSource(const MediaSource &); 91e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber MediaSource &operator=(const MediaSource &); 92e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber}; 93e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 94e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber} // namespace android 95e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber 96e46b7be812d68e49710b34048662cbf18e2a6550Andreas Huber#endif // MEDIA_SOURCE_H_ 97