/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "AndroidDecoderModule.h" #include "AndroidBridge.h" #include "GLBlitHelper.h" #include "GLContext.h" #include "GLContextEGL.h" #include "GLContextProvider.h" #include "GLImages.h" #include "GLLibraryEGL.h" #include "MediaData.h" #include "MediaInfo.h" #include "nsThreadUtils.h" #include "nsAutoPtr.h" #include "nsPromiseFlatString.h" #include "prlog.h" #include static PRLogModuleInfo* AndroidDecoderModuleLog() { static PRLogModuleInfo* sLogModule = nullptr; if (!sLogModule) { sLogModule = PR_NewLogModule("AndroidDecoderModule"); } return sLogModule; } #undef LOG #define LOG(arg, ...) MOZ_LOG(AndroidDecoderModuleLog(), \ mozilla::LogLevel::Debug, ("AndroidDecoderModule(%p)::%s: " arg, \ this, __func__, ##__VA_ARGS__)) using namespace mozilla; using namespace mozilla::gl; using namespace mozilla::widget::sdk; using media::TimeUnit; namespace mozilla { #define INVOKE_CALLBACK(Func, ...) \ if (mCallback) { \ mCallback->Func(__VA_ARGS__); \ } else { \ NS_WARNING("Callback not set"); \ } static const char* TranslateMimeType(const nsACString& aMimeType) { if (aMimeType.EqualsLiteral("video/webm; codecs=vp8")) { return "video/x-vnd.on2.vp8"; } else if (aMimeType.EqualsLiteral("video/webm; codecs=vp9")) { return "video/x-vnd.on2.vp9"; } return PromiseFlatCString(aMimeType).get(); } static MediaCodec::LocalRef CreateDecoder(const nsACString& aMimeType) { MediaCodec::LocalRef codec; NS_ENSURE_SUCCESS(MediaCodec::CreateDecoderByType(TranslateMimeType(aMimeType), &codec), nullptr); return codec; } class VideoDataDecoder : public MediaCodecDataDecoder { public: VideoDataDecoder(const VideoInfo& aConfig, MediaFormat::Param aFormat, MediaDataDecoderCallback* aCallback, layers::ImageContainer* aImageContainer) : MediaCodecDataDecoder(MediaData::Type::VIDEO_DATA, aConfig.mMimeType, aFormat, aCallback) , mImageContainer(aImageContainer) , mConfig(aConfig) { } const char* GetDescriptionName() const override { return "android video decoder"; } RefPtr Init() override { mSurfaceTexture = AndroidSurfaceTexture::Create(); if (!mSurfaceTexture) { NS_WARNING("Failed to create SurfaceTexture for video decode\n"); return InitPromise::CreateAndReject(DecoderFailureReason::INIT_ERROR, __func__); } if (NS_FAILED(InitDecoder(mSurfaceTexture->JavaSurface()))) { return InitPromise::CreateAndReject(DecoderFailureReason::INIT_ERROR, __func__); } return InitPromise::CreateAndResolve(TrackInfo::kVideoTrack, __func__); } void Cleanup() override { mGLContext = nullptr; } nsresult Input(MediaRawData* aSample) override { return MediaCodecDataDecoder::Input(aSample); } bool WantCopy() const { // Allocating a texture is incredibly slow on PowerVR and may fail on // emulators, see bug 1190379. return mGLContext->Vendor() != GLVendor::Imagination && mGLContext->Renderer() != GLRenderer::AndroidEmulator; } EGLImage CopySurface(layers::Image* img) { mGLContext->MakeCurrent(); GLuint tex = CreateTextureForOffscreen(mGLContext, mGLContext->GetGLFormats(), img->GetSize()); auto helper = mGLContext->BlitHelper(); const gl::OriginPos destOrigin = gl::OriginPos::TopLeft; if (!helper->BlitImageToTexture(img, img->GetSize(), tex, LOCAL_GL_TEXTURE_2D, destOrigin)) { mGLContext->fDeleteTextures(1, &tex); return nullptr; } EGLint attribs[] = { LOCAL_EGL_IMAGE_PRESERVED_KHR, LOCAL_EGL_TRUE, LOCAL_EGL_NONE, LOCAL_EGL_NONE }; EGLContext eglContext = static_cast(mGLContext.get())->GetEGLContext(); EGLImage eglImage = sEGLLibrary.fCreateImage( EGL_DISPLAY(), eglContext, LOCAL_EGL_GL_TEXTURE_2D_KHR, reinterpret_cast(tex), attribs); mGLContext->fDeleteTextures(1, &tex); return eglImage; } nsresult PostOutput(BufferInfo::Param aInfo, MediaFormat::Param aFormat, const TimeUnit& aDuration) override { if (!EnsureGLContext()) { return NS_ERROR_FAILURE; } RefPtr img = new SurfaceTextureImage(mSurfaceTexture.get(), mConfig.mDisplay, gl::OriginPos::BottomLeft); if (WantCopy()) { EGLImage eglImage = CopySurface(img); if (!eglImage) { return NS_ERROR_FAILURE; } EGLSync eglSync = nullptr; if (sEGLLibrary.IsExtensionSupported(GLLibraryEGL::KHR_fence_sync) && mGLContext->IsExtensionSupported(GLContext::OES_EGL_sync)) { MOZ_ASSERT(mGLContext->IsCurrent()); eglSync = sEGLLibrary.fCreateSync(EGL_DISPLAY(), LOCAL_EGL_SYNC_FENCE, nullptr); MOZ_ASSERT(eglSync); mGLContext->fFlush(); } else { NS_WARNING("No EGL fence support detected, rendering artifacts may occur!"); } img = new layers::EGLImageImage(eglImage, eglSync, mConfig.mDisplay, gl::OriginPos::TopLeft, true /* owns */); } nsresult rv; int32_t flags; NS_ENSURE_SUCCESS(rv = aInfo->Flags(&flags), rv); bool isSync = !!(flags & MediaCodec::BUFFER_FLAG_SYNC_FRAME); int32_t offset; NS_ENSURE_SUCCESS(rv = aInfo->Offset(&offset), rv); int64_t presentationTimeUs; NS_ENSURE_SUCCESS(rv = aInfo->PresentationTimeUs(&presentationTimeUs), rv); RefPtr v = VideoData::CreateFromImage(mConfig, mImageContainer, offset, presentationTimeUs, aDuration.ToMicroseconds(), img, isSync, presentationTimeUs, gfx::IntRect(0, 0, mConfig.mDisplay.width, mConfig.mDisplay.height)); INVOKE_CALLBACK(Output, v); return NS_OK; } protected: bool EnsureGLContext() { if (mGLContext) { return true; } mGLContext = GLContextProvider::CreateHeadless(CreateContextFlags::NONE); return mGLContext; } layers::ImageContainer* mImageContainer; const VideoInfo& mConfig; RefPtr mSurfaceTexture; RefPtr mGLContext; }; class AudioDataDecoder : public MediaCodecDataDecoder { public: AudioDataDecoder(const AudioInfo& aConfig, MediaFormat::Param aFormat, MediaDataDecoderCallback* aCallback) : MediaCodecDataDecoder(MediaData::Type::AUDIO_DATA, aConfig.mMimeType, aFormat, aCallback) { JNIEnv* const env = jni::GetEnvForThread(); jni::Object::LocalRef buffer(env); NS_ENSURE_SUCCESS_VOID(aFormat->GetByteBuffer(NS_LITERAL_STRING("csd-0"), &buffer)); if (!buffer && aConfig.mCodecSpecificConfig->Length() >= 2) { buffer = jni::Object::LocalRef::Adopt( env, env->NewDirectByteBuffer(aConfig.mCodecSpecificConfig->Elements(), aConfig.mCodecSpecificConfig->Length())); NS_ENSURE_SUCCESS_VOID(aFormat->SetByteBuffer(NS_LITERAL_STRING("csd-0"), buffer)); } } const char* GetDescriptionName() const override { return "android audio decoder"; } nsresult Output(BufferInfo::Param aInfo, void* aBuffer, MediaFormat::Param aFormat, const TimeUnit& aDuration) { // The output on Android is always 16-bit signed nsresult rv; int32_t numChannels; NS_ENSURE_SUCCESS(rv = aFormat->GetInteger(NS_LITERAL_STRING("channel-count"), &numChannels), rv); int32_t sampleRate; NS_ENSURE_SUCCESS(rv = aFormat->GetInteger(NS_LITERAL_STRING("sample-rate"), &sampleRate), rv); int32_t size; NS_ENSURE_SUCCESS(rv = aInfo->Size(&size), rv); int32_t offset; NS_ENSURE_SUCCESS(rv = aInfo->Offset(&offset), rv); #ifdef MOZ_SAMPLE_TYPE_S16 const int32_t numSamples = size / 2; #else #error We only support 16-bit integer PCM #endif const int32_t numFrames = numSamples / numChannels; auto audio = MakeUnique(numSamples); const uint8_t* bufferStart = static_cast(aBuffer) + offset; PodCopy(audio.get(), reinterpret_cast(bufferStart), numSamples); int64_t presentationTimeUs; NS_ENSURE_SUCCESS(rv = aInfo->PresentationTimeUs(&presentationTimeUs), rv); RefPtr data = new AudioData(0, presentationTimeUs, aDuration.ToMicroseconds(), numFrames, Move(audio), numChannels, sampleRate); INVOKE_CALLBACK(Output, data); return NS_OK; } }; bool AndroidDecoderModule::SupportsMimeType(const nsACString& aMimeType) const { if (!AndroidBridge::Bridge() || AndroidBridge::Bridge()->GetAPIVersion() < 16) { return false; } if (aMimeType.EqualsLiteral("video/mp4") || aMimeType.EqualsLiteral("video/avc")) { return true; } // When checking "audio/x-wav", CreateDecoder can cause a JNI ERROR by // Accessing a stale local reference leading to a SIGSEGV crash. // To avoid this we check for wav types here. if (aMimeType.EqualsLiteral("audio/x-wav") || aMimeType.EqualsLiteral("audio/wave; codecs=1") || aMimeType.EqualsLiteral("audio/wave; codecs=6") || aMimeType.EqualsLiteral("audio/wave; codecs=7") || aMimeType.EqualsLiteral("audio/wave; codecs=65534")) { return false; } return widget::HardwareCodecCapabilityUtils::FindDecoderCodecInfoForMimeType( nsCString(TranslateMimeType(aMimeType))); } already_AddRefed AndroidDecoderModule::CreateVideoDecoder( const VideoInfo& aConfig, layers::LayersBackend aLayersBackend, layers::ImageContainer* aImageContainer, FlushableTaskQueue* aVideoTaskQueue, MediaDataDecoderCallback* aCallback) { MediaFormat::LocalRef format; NS_ENSURE_SUCCESS(MediaFormat::CreateVideoFormat( TranslateMimeType(aConfig.mMimeType), aConfig.mDisplay.width, aConfig.mDisplay.height, &format), nullptr); RefPtr decoder = new VideoDataDecoder(aConfig, format, aCallback, aImageContainer); return decoder.forget(); } already_AddRefed AndroidDecoderModule::CreateAudioDecoder( const AudioInfo& aConfig, FlushableTaskQueue* aAudioTaskQueue, MediaDataDecoderCallback* aCallback) { MOZ_ASSERT(aConfig.mBitDepth == 16, "We only handle 16-bit audio!"); MediaFormat::LocalRef format; NS_ENSURE_SUCCESS(MediaFormat::CreateAudioFormat( aConfig.mMimeType, aConfig.mBitDepth, aConfig.mChannels, &format), nullptr); RefPtr decoder = new AudioDataDecoder(aConfig, format, aCallback); return decoder.forget(); } PlatformDecoderModule::ConversionRequired AndroidDecoderModule::DecoderNeedsConversion(const TrackInfo& aConfig) const { if (aConfig.IsVideo()) { return kNeedAnnexB; } return kNeedNone; } MediaCodecDataDecoder::MediaCodecDataDecoder(MediaData::Type aType, const nsACString& aMimeType, MediaFormat::Param aFormat, MediaDataDecoderCallback* aCallback) : mType(aType) , mMimeType(aMimeType) , mFormat(aFormat) , mCallback(aCallback) , mInputBuffers(nullptr) , mOutputBuffers(nullptr) , mMonitor("MediaCodecDataDecoder::mMonitor") , mState(kDecoding) { } MediaCodecDataDecoder::~MediaCodecDataDecoder() { Shutdown(); } RefPtr MediaCodecDataDecoder::Init() { nsresult rv = InitDecoder(nullptr); TrackInfo::TrackType type = (mType == MediaData::AUDIO_DATA ? TrackInfo::TrackType::kAudioTrack : TrackInfo::TrackType::kVideoTrack); return NS_SUCCEEDED(rv) ? InitPromise::CreateAndResolve(type, __func__) : InitPromise::CreateAndReject( MediaDataDecoder::DecoderFailureReason::INIT_ERROR, __func__); } nsresult MediaCodecDataDecoder::InitDecoder(Surface::Param aSurface) { mDecoder = CreateDecoder(mMimeType); if (!mDecoder) { INVOKE_CALLBACK(Error); return NS_ERROR_FAILURE; } nsresult rv; NS_ENSURE_SUCCESS(rv = mDecoder->Configure(mFormat, aSurface, nullptr, 0), rv); NS_ENSURE_SUCCESS(rv = mDecoder->Start(), rv); NS_ENSURE_SUCCESS(rv = ResetInputBuffers(), rv); NS_ENSURE_SUCCESS(rv = ResetOutputBuffers(), rv); NS_NewNamedThread("MC Decoder", getter_AddRefs(mThread), NS_NewRunnableMethod(this, &MediaCodecDataDecoder::DecoderLoop)); return NS_OK; } // This is in usec, so that's 10ms. static const int64_t kDecoderTimeout = 10000; #define BREAK_ON_DECODER_ERROR() \ if (NS_FAILED(res)) { \ NS_WARNING("Exiting decoder loop due to exception"); \ if (State() == kDrainDecoder) { \ INVOKE_CALLBACK(DrainComplete); \ State(kDecoding); \ } \ INVOKE_CALLBACK(Error); \ break; \ } nsresult MediaCodecDataDecoder::GetInputBuffer( JNIEnv* aEnv, int aIndex, jni::Object::LocalRef* aBuffer) { MOZ_ASSERT(aEnv); MOZ_ASSERT(!*aBuffer); int numTries = 2; while (numTries--) { *aBuffer = jni::Object::LocalRef::Adopt( aEnv->GetObjectArrayElement(mInputBuffers.Get(), aIndex)); if (*aBuffer) { return NS_OK; } nsresult res = ResetInputBuffers(); if (NS_FAILED(res)) { return res; } } return NS_ERROR_FAILURE; } bool MediaCodecDataDecoder::WaitForInput() { MonitorAutoLock lock(mMonitor); while (State() == kDecoding && mQueue.empty()) { // Signal that we require more input. INVOKE_CALLBACK(InputExhausted); lock.Wait(); } return State() != kStopping; } MediaRawData* MediaCodecDataDecoder::PeekNextSample() { MonitorAutoLock lock(mMonitor); if (State() == kFlushing) { mDecoder->Flush(); ClearQueue(); State(kDecoding); lock.Notify(); return nullptr; } if (mQueue.empty()) { if (State() == kDrainQueue) { State(kDrainDecoder); } return nullptr; } // We're not stopping or flushing, so try to get a sample. return mQueue.front(); } nsresult MediaCodecDataDecoder::QueueSample(const MediaRawData* aSample) { MOZ_ASSERT(aSample); AutoLocalJNIFrame frame(jni::GetEnvForThread(), 1); // We have a sample, try to feed it to the decoder. int32_t inputIndex = -1; nsresult res = mDecoder->DequeueInputBuffer(kDecoderTimeout, &inputIndex); if (NS_FAILED(res)) { return res; } if (inputIndex < 0) { // There is no valid input buffer available. return NS_ERROR_FAILURE; } jni::Object::LocalRef buffer(frame.GetEnv()); res = GetInputBuffer(frame.GetEnv(), inputIndex, &buffer); if (NS_FAILED(res)) { return res; } void* directBuffer = frame.GetEnv()->GetDirectBufferAddress(buffer.Get()); MOZ_ASSERT(frame.GetEnv()->GetDirectBufferCapacity(buffer.Get()) >= aSample->Size(), "Decoder buffer is not large enough for sample"); PodCopy(static_cast(directBuffer), aSample->Data(), aSample->Size()); res = mDecoder->QueueInputBuffer(inputIndex, 0, aSample->Size(), aSample->mTime, 0); if (NS_FAILED(res)) { return res; } mDurations.push(TimeUnit::FromMicroseconds(aSample->mDuration)); return NS_OK; } nsresult MediaCodecDataDecoder::QueueEOS() { mMonitor.AssertCurrentThreadOwns(); nsresult res = NS_OK; int32_t inputIndex = -1; res = mDecoder->DequeueInputBuffer(kDecoderTimeout, &inputIndex); if (NS_FAILED(res) || inputIndex < 0) { return res; } res = mDecoder->QueueInputBuffer(inputIndex, 0, 0, 0, MediaCodec::BUFFER_FLAG_END_OF_STREAM); if (NS_SUCCEEDED(res)) { State(kDrainWaitEOS); mMonitor.Notify(); } return res; } void MediaCodecDataDecoder::HandleEOS(int32_t aOutputStatus) { MonitorAutoLock lock(mMonitor); if (State() == kDrainWaitEOS) { State(kDecoding); mMonitor.Notify(); INVOKE_CALLBACK(DrainComplete); } mDecoder->ReleaseOutputBuffer(aOutputStatus, false); } TimeUnit MediaCodecDataDecoder::GetOutputDuration() { MOZ_ASSERT(!mDurations.empty(), "Should have had a duration queued"); const TimeUnit duration = mDurations.front(); mDurations.pop(); return duration; } nsresult MediaCodecDataDecoder::ProcessOutput( BufferInfo::Param aInfo, MediaFormat::Param aFormat, int32_t aStatus) { AutoLocalJNIFrame frame(jni::GetEnvForThread(), 1); const TimeUnit duration = GetOutputDuration(); const auto buffer = jni::Object::LocalRef::Adopt( frame.GetEnv()->GetObjectArrayElement(mOutputBuffers.Get(), aStatus)); if (buffer) { // The buffer will be null on Android L if we are decoding to a Surface. void* directBuffer = frame.GetEnv()->GetDirectBufferAddress(buffer.Get()); Output(aInfo, directBuffer, aFormat, duration); } // The Surface will be updated at this point (for video). mDecoder->ReleaseOutputBuffer(aStatus, true); PostOutput(aInfo, aFormat, duration); return NS_OK; } void MediaCodecDataDecoder::DecoderLoop() { bool isOutputDone = false; AutoLocalJNIFrame frame(jni::GetEnvForThread(), 1); RefPtr sample; MediaFormat::LocalRef outputFormat(frame.GetEnv()); nsresult res = NS_OK; while (WaitForInput()) { sample = PeekNextSample(); { MonitorAutoLock lock(mMonitor); if (State() == kDrainDecoder) { MOZ_ASSERT(!sample, "Shouldn't have a sample when pushing EOF frame"); res = QueueEOS(); BREAK_ON_DECODER_ERROR(); } } if (sample) { res = QueueSample(sample); if (NS_SUCCEEDED(res)) { // We've fed this into the decoder, so remove it from the queue. MonitorAutoLock lock(mMonitor); mQueue.pop(); isOutputDone = false; } } if (isOutputDone) { continue; } BufferInfo::LocalRef bufferInfo; nsresult res = BufferInfo::New(&bufferInfo); BREAK_ON_DECODER_ERROR(); int32_t outputStatus = -1; res = mDecoder->DequeueOutputBuffer(bufferInfo, kDecoderTimeout, &outputStatus); BREAK_ON_DECODER_ERROR(); if (outputStatus == MediaCodec::INFO_TRY_AGAIN_LATER) { // We might want to call mCallback->InputExhausted() here, but there seems // to be some possible bad interactions here with the threading. } else if (outputStatus == MediaCodec::INFO_OUTPUT_BUFFERS_CHANGED) { res = ResetOutputBuffers(); BREAK_ON_DECODER_ERROR(); } else if (outputStatus == MediaCodec::INFO_OUTPUT_FORMAT_CHANGED) { res = mDecoder->GetOutputFormat(ReturnTo(&outputFormat)); BREAK_ON_DECODER_ERROR(); } else if (outputStatus < 0) { NS_WARNING("Unknown error from decoder!"); INVOKE_CALLBACK(Error); // Don't break here just in case it's recoverable. If it's not, other // stuff will fail later and we'll bail out. } else { // We have a valid buffer index >= 0 here. int32_t flags; nsresult res = bufferInfo->Flags(&flags); BREAK_ON_DECODER_ERROR(); if (flags & MediaCodec::BUFFER_FLAG_END_OF_STREAM) { HandleEOS(outputStatus); isOutputDone = true; // We only queue empty EOF frames, so we're done for now. continue; } res = ProcessOutput(bufferInfo, outputFormat, outputStatus); BREAK_ON_DECODER_ERROR(); } } Cleanup(); // We're done. MonitorAutoLock lock(mMonitor); State(kShutdown); mMonitor.Notify(); } const char* MediaCodecDataDecoder::ModuleStateStr(ModuleState aState) { static const char* kStr[] = { "Decoding", "Flushing", "DrainQueue", "DrainDecoder", "DrainWaitEOS", "Stopping", "Shutdown" }; MOZ_ASSERT(aState < sizeof(kStr) / sizeof(kStr[0])); return kStr[aState]; } MediaCodecDataDecoder::ModuleState MediaCodecDataDecoder::State() const { return mState; } void MediaCodecDataDecoder::State(ModuleState aState) { LOG("%s -> %s", ModuleStateStr(mState), ModuleStateStr(aState)); if (aState == kDrainDecoder) { MOZ_ASSERT(mState == kDrainQueue); } else if (aState == kDrainWaitEOS) { MOZ_ASSERT(mState == kDrainDecoder); } mState = aState; } void MediaCodecDataDecoder::ClearQueue() { mMonitor.AssertCurrentThreadOwns(); while (!mQueue.empty()) { mQueue.pop(); } while (!mDurations.empty()) { mDurations.pop(); } } nsresult MediaCodecDataDecoder::Input(MediaRawData* aSample) { MonitorAutoLock lock(mMonitor); mQueue.push(aSample); lock.NotifyAll(); return NS_OK; } nsresult MediaCodecDataDecoder::ResetInputBuffers() { return mDecoder->GetInputBuffers(ReturnTo(&mInputBuffers)); } nsresult MediaCodecDataDecoder::ResetOutputBuffers() { return mDecoder->GetOutputBuffers(ReturnTo(&mOutputBuffers)); } nsresult MediaCodecDataDecoder::Flush() { MonitorAutoLock lock(mMonitor); State(kFlushing); lock.Notify(); while (State() == kFlushing) { lock.Wait(); } return NS_OK; } nsresult MediaCodecDataDecoder::Drain() { MonitorAutoLock lock(mMonitor); if (State() == kDrainDecoder || State() == kDrainQueue) { return NS_OK; } State(kDrainQueue); lock.Notify(); return NS_OK; } nsresult MediaCodecDataDecoder::Shutdown() { MonitorAutoLock lock(mMonitor); if (!mThread || State() == kStopping) { // Already shutdown or in the process of doing so return NS_OK; } State(kStopping); lock.Notify(); while (State() == kStopping) { lock.Wait(); } mThread->Shutdown(); mThread = nullptr; mDecoder->Stop(); mDecoder->Release(); return NS_OK; } } // mozilla