src/modules/video_render/main/source/Android/video_render_android_impl.h

/*
 *  Copyright (c) 2011 The WebRTC project authors. All Rights Reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */

#ifndef WEBRTC_MODULES_VIDEO_RENDER_MAIN_SOURCE_ANDROID_VIDEO_RENDER_ANDROID_IMPL_H_
#define WEBRTC_MODULES_VIDEO_RENDER_MAIN_SOURCE_ANDROID_VIDEO_RENDER_ANDROID_IMPL_H_

#include <jni.h>
#include "i_video_render.h"
#include "map_wrapper.h"


namespace webrtc {

//#define ANDROID_LOG


class CriticalSectionWrapper;
class EventWrapper;
class ThreadWrapper;


// The object a module user uses to send new frames to the java renderer
// Base class for android render streams.

class AndroidStream: public VideoRenderCallback
{
public:
    /*
     * DeliverFrame is called from a thread connected to the Java VM.
     *  Used for Delivering frame for rendering.
     */
    virtual void DeliverFrame(JNIEnv* jniEnv)=0;

    virtual ~AndroidStream()
    {
    };
};

class VideoRenderAndroid: IVideoRender
{
public:
    static WebRtc_Word32 SetAndroidEnvVariables(void* javaVM);

    VideoRenderAndroid(const WebRtc_Word32 id,
                       const VideoRenderType videoRenderType, void* window,
                       const bool fullscreen);

    virtual ~VideoRenderAndroid();

    virtual WebRtc_Word32 Init()=0;

    virtual WebRtc_Word32 ChangeUniqueId(const WebRtc_Word32 id);

    virtual WebRtc_Word32 ChangeWindow(void* window);

    virtual VideoRenderCallback
            * AddIncomingRenderStream(const WebRtc_UWord32 streamId,
                                      const WebRtc_UWord32 zOrder,
                                      const float left, const float top,
                                      const float right, const float bottom);

    virtual WebRtc_Word32
            DeleteIncomingRenderStream(const WebRtc_UWord32 streamId);

    virtual WebRtc_Word32
            GetIncomingRenderStreamProperties(const WebRtc_UWord32 streamId,
                                              WebRtc_UWord32& zOrder,
                                              float& left, float& top,
                                              float& right, float& bottom) const;
    virtual WebRtc_Word32 StartRender();

    virtual WebRtc_Word32 StopRender();

    virtual void ReDraw();

    /**************************************************************************
     *
     *   Properties
     *
     ***************************************************************************/

    virtual VideoRenderType RenderType();

    virtual RawVideoType PerferedVideoType();

    virtual bool FullScreen();

    virtual WebRtc_Word32
            GetGraphicsMemory(WebRtc_UWord64& totalGraphicsMemory,
                              WebRtc_UWord64& availableGraphicsMemory) const;

    virtual WebRtc_Word32
            GetScreenResolution(WebRtc_UWord32& screenWidth,
                                WebRtc_UWord32& screenHeight) const;

    virtual WebRtc_UWord32 RenderFrameRate(const WebRtc_UWord32 streamId);

    virtual WebRtc_Word32 SetStreamCropping(const WebRtc_UWord32 streamId,
                                            const float left, const float top,
                                            const float right,
                                            const float bottom);

    virtual WebRtc_Word32 SetTransparentBackground(const bool enable);

    virtual WebRtc_Word32 ConfigureRenderer(const WebRtc_UWord32 streamId,
                                            const unsigned int zOrder,
                                            const float left, const float top,
                                            const float right,
                                            const float bottom);

    virtual WebRtc_Word32 SetText(const WebRtc_UWord8 textId,
                                  const WebRtc_UWord8* text,
                                  const WebRtc_Word32 textLength,
                                  const WebRtc_UWord32 textColorRef,
                                  const WebRtc_UWord32 backgroundColorRef,
                                  const float left, const float top,
                                  const float rigth, const float bottom);

    virtual WebRtc_Word32 SetBitmap(const void* bitMap,
                                    const WebRtc_UWord8 pictureId,
                                    const void* colorKey, const float left,
                                    const float top, const float right,
                                    const float bottom);

protected:
    virtual AndroidStream
            * CreateAndroidRenderChannel(WebRtc_Word32 streamId,
                                         WebRtc_Word32 zOrder,
                                         const float left, const float top,
                                         const float right, const float bottom,
                                         VideoRenderAndroid& renderer) = 0;

    WebRtc_Word32 _id;
    CriticalSectionWrapper& _critSect;
    VideoRenderType _renderType;
    jobject _ptrWindow;

    static JavaVM* g_jvm;

private:
    static bool JavaRenderThreadFun(void* obj);
    bool JavaRenderThreadProcess();

    MapWrapper _streamsMap; // Map with streams to render.
    bool _javaShutDownFlag; // True if the _javaRenderThread thread shall be detached from the JVM.
    EventWrapper& _javaShutdownEvent;
    EventWrapper& _javaRenderEvent;
    WebRtc_Word64 _lastJavaRenderEvent;
    JNIEnv* _javaRenderJniEnv; // JNIEnv for the java render thread.
    ThreadWrapper* _javaRenderThread;
};

} //namespace webrtc

#endif // WEBRTC_MODULES_VIDEO_RENDER_MAIN_SOURCE_ANDROID_VIDEO_RENDER_ANDROID_IMPL_H_