AVChatParameters.java

浏览该文件的文档.

/*
 * Copyright (c) 2014-2018 NetEase, Inc.
 * All right reserved.
 */

package com.netease.nimlib.sdk.avchat.model;

import android.view.Surface;

import com.netease.nimlib.sdk.avchat.AVChatCallback;
import com.netease.nimlib.sdk.avchat.AVChatManager;
import com.netease.nimlib.sdk.avchat.AVChatManagerLite;
import com.netease.nimlib.sdk.avchat.AVChatStateObserver;
import com.netease.nimlib.sdk.avchat.AVChatStateObserverLite;
import com.netease.nimlib.sdk.avchat.constant.AVChatAudioEffectMode;
import com.netease.nimlib.sdk.avchat.constant.AVChatAudioSampleRate;
import com.netease.nimlib.sdk.avchat.constant.AVChatMediaCodecMode;
import com.netease.nimlib.sdk.avchat.constant.AVChatServerRecordMode;
import com.netease.nimlib.sdk.avchat.constant.AVChatType;
import com.netease.nimlib.sdk.avchat.constant.AVChatUserRole;
import com.netease.nimlib.sdk.avchat.constant.AVChatVideoCaptureOrientation;
import com.netease.nimlib.sdk.avchat.constant.AVChatVideoCropRatio;
import com.netease.nimlib.sdk.avchat.constant.AVChatVideoFrameRate;
import com.netease.nimlib.sdk.avchat.constant.AVChatVideoQuality;
import com.netease.yunxin.base.annotation.IntDef;
import com.netease.yunxin.base.annotation.Runtime;
import com.netease.yunxin.base.annotation.StringDef;
import com.netease.yunxin.base.annotation.Writable;
import com.netease.nrtc.engine.rawapi.RtcKey;
import com.netease.nrtc.engine.rawapi.RtcParameters;
import com.netease.nrtc.sdk.common.VideoFilterParameter;
import com.netease.nrtc.sdk.video.VideoFrame;

import java.io.Serializable;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static com.netease.nimlib.sdk.avchat.constant.AVChatAudioEffectMode.DISABLE;
import static com.netease.nimlib.sdk.avchat.constant.AVChatAudioEffectMode.PLATFORM_BUILTIN;
import static com.netease.nimlib.sdk.avchat.constant.AVChatAudioEffectMode.SDK_BUILTIN;
import static com.netease.nimlib.sdk.avchat.constant.AVChatMediaCodecMode.MEDIA_CODEC_AUTO;
import static com.netease.nimlib.sdk.avchat.constant.AVChatMediaCodecMode.MEDIA_CODEC_HARDWARE;
import static com.netease.nimlib.sdk.avchat.constant.AVChatMediaCodecMode.MEDIA_CODEC_SOFTWARE;
import static com.netease.nimlib.sdk.avchat.constant.AVChatServerRecordMode.MIX;
import static com.netease.nimlib.sdk.avchat.constant.AVChatServerRecordMode.MIX_AND_SINGLE;
import static com.netease.nimlib.sdk.avchat.constant.AVChatServerRecordMode.SINGLE;
import static com.netease.nimlib.sdk.avchat.constant.AVChatVideoFrameRate.FRAME_RATE_10;
import static com.netease.nimlib.sdk.avchat.constant.AVChatVideoFrameRate.FRAME_RATE_15;
import static com.netease.nimlib.sdk.avchat.constant.AVChatVideoFrameRate.FRAME_RATE_20;
import static com.netease.nimlib.sdk.avchat.constant.AVChatVideoFrameRate.FRAME_RATE_25;
import static com.netease.nimlib.sdk.avchat.constant.AVChatVideoFrameRate.FRAME_RATE_5;
import static com.netease.nimlib.sdk.avchat.model.AVChatImageFormat.I420;
import static com.netease.nimlib.sdk.avchat.model.AVChatImageFormat.NV21;


public class AVChatParameters {


    public static class Key<T> implements Serializable {

        private final RtcKey<T> mKey;
        private final boolean mWritable;
        private final boolean mRuntime;

//        /**
//         * @param name 参数名
//         */
//        public Key(final String name) {
//            ParameterizedType thisType = (ParameterizedType) getClass().getGenericSuperclass();
//            Type type = thisType.getActualTypeArguments()[0];
//            mKey = new RtcKey<>(name, (Class<T>) type);
//            mWritable = RtcParameters.writeSupported(name);
//            mRuntime = RtcParameters.runtimeSupported(name);
//        }

        Key(final String name, Class<T> clazz) {
            mKey = new RtcKey<>(name, clazz);
            mWritable = RtcParameters.writeSupported(name);
            mRuntime = RtcParameters.runtimeSupported(name);
        }


        private static class SpecializedKey<T> extends Key<T> {
            SpecializedKey(String name, Class<T> clazz) {
                super(name, clazz);
            }
        }


        public static Key<?> createSpecializedKey(final String name) {
            Class<?> clazz = RtcParameters.getKeyType(name);
            if (clazz == null) {
                throw new IllegalArgumentException(
                        "Key " + name + " unsupported！");
            }
            return new SpecializedKey<>(name, clazz);
        }

        public String name() {
            return mKey.getName();
        }

        public boolean runtime() {
            return mRuntime;
        }

        public boolean writable() {
            return mWritable;
        }


        public final Class<T> type() {
            return mKey.getType();
        }

        @Override
        public final int hashCode() {
            return mKey.hashCode();
        }

        @SuppressWarnings("unchecked")
        @Override
        public final boolean equals(Object o) {
            return o instanceof Key && ((Key<T>) o).mKey.equals(mKey);
        }

        @Override
        public String toString() {
            return String.format("Key(Name:%s, Type:%s, Writable:%s, Runtime:%s)", name(), type(), writable(), runtime());
        }

    }


    @Writable
    @IntDef({Surface.ROTATION_0,
            Surface.ROTATION_90,
            Surface.ROTATION_180,
            Surface.ROTATION_270})
    public static final Key<Integer> KEY_DEVICE_DEFAULT_ROTATION = new Key<>(RtcParameters.KEY_DEVICE_DEFAULT_ROTATION, Integer.class);


    @Writable
    @IntDef({Surface.ROTATION_0,
            Surface.ROTATION_90,
            Surface.ROTATION_180,
            Surface.ROTATION_270})
    public static final Key<Integer> KEY_DEVICE_ROTATION_FIXED_OFFSET = new Key<>(RtcParameters.KEY_DEVICE_ROTATION_FIXED_OFFSET, Integer.class);


    @Runtime
    @Writable
    @StringDef({MEDIA_CODEC_AUTO,
            MEDIA_CODEC_HARDWARE,
            MEDIA_CODEC_SOFTWARE})
    public static final Key<String> KEY_VIDEO_ENCODER_MODE = new Key<>(RtcParameters.KEY_VIDEO_ENCODER_MODE, String.class);


    @Runtime
    @Writable
    @StringDef({MEDIA_CODEC_AUTO,
            MEDIA_CODEC_HARDWARE,
            MEDIA_CODEC_SOFTWARE})
    public static final Key<String> KEY_VIDEO_DECODER_MODE = new Key<>(RtcParameters.KEY_VIDEO_DECODER_MODE, String.class);


    @Runtime
    public static final Key<Boolean> KEY_VIDEO_SUPPORTED_HW_ENCODER = new Key<>(RtcParameters.KEY_VIDEO_SUPPORTED_HW_ENCODER, Boolean.class);


    @Runtime
    public static final Key<Boolean> KEY_VIDEO_SUPPORTED_HW_DECODER = new Key<>(RtcParameters.KEY_VIDEO_SUPPORTED_HW_DECODER, Boolean.class);


    @Writable
    @StringDef({DISABLE,
            PLATFORM_BUILTIN,
            SDK_BUILTIN})
    public static final Key<String> KEY_AUDIO_EFFECT_NOISE_SUPPRESSOR = new Key<>(RtcParameters.KEY_AUDIO_EFFECT_NOISE_SUPPRESSOR, String.class);


    @Writable
    @StringDef({DISABLE,
            PLATFORM_BUILTIN,
            SDK_BUILTIN})
    public static final Key<String> KEY_AUDIO_EFFECT_AUTOMATIC_GAIN_CONTROL = new Key<>(RtcParameters.KEY_AUDIO_EFFECT_AUTOMATIC_GAIN_CONTROL, String.class);


    @Writable
    @StringDef({DISABLE,
            PLATFORM_BUILTIN,
            SDK_BUILTIN})
    public static final Key<String> KEY_AUDIO_EFFECT_ACOUSTIC_ECHO_CANCELER = new Key<>(RtcParameters.KEY_AUDIO_EFFECT_ACOUSTIC_ECHO_CANCELER, String.class);


    @Writable
    public static final Key<Boolean> KEY_AUDIO_CALL_PROXIMITY = new Key<>(RtcParameters.KEY_AUDIO_CALL_PROXIMITY, Boolean.class);


    @Writable
    @Runtime
    @IntDef({AVChatVideoQuality.QUALITY_LOW,
            AVChatVideoQuality.QUALITY_MEDIUM,
            AVChatVideoQuality.QUALITY_HIGH,
            AVChatVideoQuality.QUALITY_480P,
            AVChatVideoQuality.QUALITY_540P,
            AVChatVideoQuality.QUALITY_720P,
            AVChatVideoQuality.QUALITY_DEFAULT})
    public static final Key<Integer> KEY_VIDEO_QUALITY = new Key<>(RtcParameters.KEY_VIDEO_QUALITY, Integer.class);


    @Writable
    @Runtime
    @IntDef({AVChatVideoQuality.QUALITY_LOW,
            AVChatVideoQuality.QUALITY_MEDIUM,
            AVChatVideoQuality.QUALITY_HIGH,
            AVChatVideoQuality.QUALITY_480P,
            AVChatVideoQuality.QUALITY_540P,
            AVChatVideoQuality.QUALITY_720P,
            AVChatVideoQuality.QUALITY_DEFAULT})
    public static final Key<Integer> KEY_VIDEO_PREVIEW_QUALITY = new Key<>(RtcParameters.KEY_VIDEO_PREVIEW_QUALITY, Integer.class);


    @Writable
    @Runtime
    public static final Key<Boolean> KEY_VIDEO_ROTATE_IN_RENDING = new Key<>(RtcParameters.KEY_VIDEO_ROTATE_IN_RENDING, Boolean.class);


    @Runtime
    @Writable
    @IntDef({AVChatUserRole.AUDIENCE, AVChatUserRole.NORMAL})
    public static final Key<Integer> KEY_SESSION_MULTI_MODE_USER_ROLE = new Key<>(RtcParameters.KEY_SESSION_MULTI_MODE_USER_ROLE, Integer.class);


    @Runtime
    @Writable
    public static final Key<Boolean> KEY_VIDEO_FPS_REPORTED = new Key<>(RtcParameters.KEY_VIDEO_FPS_REPORTED, Boolean.class);


    @Runtime
    @Writable
    public static final Key<Integer> KEY_VIDEO_MAX_BITRATE = new Key<>(RtcParameters.KEY_VIDEO_MAX_BITRATE, Integer.class);

    @Writable
    @Runtime
    @IntDef({FRAME_RATE_5,
            FRAME_RATE_10,
            FRAME_RATE_15,
            FRAME_RATE_20,
            FRAME_RATE_25})
    public static final Key<Integer> KEY_VIDEO_FRAME_RATE = new Key<>(RtcParameters.KEY_VIDEO_FRAME_RATE, Integer.class);


    @Writable
    @Runtime
    public static final Key<Boolean> KEY_VIDEO_FRAME_FILTER = new Key<>(RtcParameters.KEY_VIDEO_FRAME_FILTER, Boolean.class);


    @Writable
    @Runtime
    public static final Key<Boolean> KEY_VIDEO_FRAME_FILTER_NEW = new Key<>(RtcParameters.KEY_VIDEO_FRAME_FILTER_NEW, Boolean.class);


    @Writable
    @Runtime
    @IntDef({NV21,
            I420})
    public static final Key<Integer> KEY_VIDEO_FRAME_FILTER_FORMAT = new Key<>(RtcParameters.KEY_VIDEO_FRAME_FILTER_FORMAT, Integer.class);


    @Writable
    @Runtime
    public static final Key<Boolean> KEY_AUDIO_FRAME_FILTER = new Key<>(RtcParameters.KEY_AUDIO_FRAME_FILTER, Boolean.class);


    @Deprecated
    @Runtime
    @Writable
    public static final Key<String> KEY_SESSION_LIVE_URL = new Key<>(RtcParameters.KEY_SESSION_LIVE_URL, String.class);


    @Writable
    @Runtime
    public static final Key<Boolean> KEY_AUDIO_REPORT_SPEAKER = new Key<>(RtcParameters.KEY_AUDIO_REPORT_SPEAKER, Boolean.class);


    @Writable
    public static final Key<Boolean> KEY_AUDIO_HIGH_QUALITY = new Key<>(RtcParameters.KEY_AUDIO_HIGH_QUALITY, Boolean.class);


    @Writable
    @Runtime
    @IntDef({AVChatVideoCaptureOrientation.ORIENTATION_PORTRAIT,
            AVChatVideoCaptureOrientation.ORIENTATION_PORTRAIT_UPSIDEDOWN,
            AVChatVideoCaptureOrientation.ORIENTATION_LANDSCAPE_LEFT,
            AVChatVideoCaptureOrientation.ORIENTATION_LANDSCAPE_RIGHT})
    public static final Key<Integer> KEY_VIDEO_CAPTURE_ORIENTATION = new Key<>(RtcParameters.KEY_VIDEO_CAPTURE_ORIENTATION, Integer.class);


    @Writable
    @Runtime
    @IntDef({AVChatVideoCropRatio.CROP_RATIO_NONE,
            AVChatVideoCropRatio.CROP_RATIO_1_1,
            AVChatVideoCropRatio.CROP_RATIO_4_3,
            AVChatVideoCropRatio.CROP_RATIO_16_9})
    public static final Key<Integer> KEY_VIDEO_FIXED_CROP_RATIO = new Key<>(RtcParameters.KEY_VIDEO_FIXED_CROP_RATIO, Integer.class);


    @Writable
    @Runtime
    public static final Key<Boolean> KEY_VIDEO_LOCAL_PREVIEW_MIRROR = new Key<>(RtcParameters.KEY_VIDEO_LOCAL_PREVIEW_MIRROR, Boolean.class);


    @Runtime
    @Writable
    public static final Key<Boolean> KEY_VIDEO_TRANSPORT_MIRROR = new Key<>(RtcParameters.KEY_VIDEO_TRANSPORT_MIRROR, Boolean.class);


    @Writable
    public static final Key<Boolean> KEY_SERVER_AUDIO_RECORD = new Key<>(RtcParameters.KEY_SERVER_AUDIO_RECORD, Boolean.class);


    @Writable
    public static final Key<Boolean> KEY_SERVER_VIDEO_RECORD = new Key<>(RtcParameters.KEY_SERVER_VIDEO_RECORD, Boolean.class);


    @Writable
    @Runtime
    @IntDef({MIX_AND_SINGLE,
            MIX,
            SINGLE})
    public static final Key<Integer> KEY_SERVER_RECORD_MODE = new Key<>(RtcParameters.KEY_SERVER_RECORD_MODE, Integer.class);


    @Writable
    public static final Key<Boolean> KEY_SERVER_RECORD_SPEAKER = new Key<>(RtcParameters.KEY_SERVER_RECORD_SPEAKER, Boolean.class);


    @Deprecated
    @Writable
    public static final Key<Boolean> KEY_SERVER_LIVE_RECORD = new Key<>(RtcParameters.KEY_SERVER_LIVE_RECORD, Boolean.class);


    @Deprecated
    @Writable
    public static final Key<AVChatLiveCompositingLayout> KEY_SESSION_LIVE_COMPOSITING_LAYOUT =
            new Key<>(RtcParameters.KEY_SESSION_LIVE_COMPOSITING_LAYOUT, AVChatLiveCompositingLayout.class);


    @Writable
    public static final Key<Boolean> KEY_SESSION_LIVE_MODE = new Key<>(RtcParameters.KEY_SESSION_LIVE_MODE, Boolean.class);

    @Writable
    public static final Key<String> KEY_COMPATIBILITY_CONFIG_SERVER =
            new Key<>(RtcParameters.KEY_COMPATIBILITY_CONFIG_SERVER, String.class);

    @Writable
    public static final Key<String> KEY_COMPATIBILITY_CONFIG_LOCAL =
            new Key<>(RtcParameters.KEY_COMPATIBILITY_CONFIG_LOCAL, String.class);


    @Writable
    @Deprecated
    public static final Key<Boolean> KEY_AUDIO_EXTERNAL_CAPTURE =
            new Key<>(RtcParameters.KEY_AUDIO_EXTERNAL_CAPTURE, Boolean.class);

    @Writable
    public static final Key<Integer> KEY_AUDIO_PROCESS_DUMP_FLAG_DEBUG =
            new Key<>(RtcParameters.KEY_AUDIO_PROCESS_DUMP_FLAG_DEBUG, Integer.class);


    @Writable
    @Runtime
    public static final Key<Boolean> KEY_PROFILE_TRACE_FLAG_DEBUG =
            new Key<>(RtcParameters.KEY_PROFILE_TRACE_FLAG_DEBUG, Boolean.class);


    @Writable
    @IntDef({AVChatAudioSampleRate.SAMPLE_RATE_8000_HZ,
            AVChatAudioSampleRate.SAMPLE_RATE_16000_HZ,
            AVChatAudioSampleRate.SAMPLE_RATE_32000_HZ,
            AVChatAudioSampleRate.SAMPLE_RATE_48000_HZ})
    public static final Key<Integer> KEY_AUDIO_PLAYBACK_DEFAULT_SAMPLE_RATE =
            new Key<>(RtcParameters.KEY_AUDIO_PLAYBACK_DEFAULT_SAMPLE_RATE, Integer.class);


    private RtcParameters mRawParams;

    public AVChatParameters() {
        mRawParams = new RtcParameters();
    }

    public void clear() {
        mRawParams.clear();
    }

    public RtcParameters getRawParameters() {
        return mRawParams;
    }

    public void setRawParameters(RtcParameters parameters) {
        mRawParams = new RtcParameters();

        Set<String> keys = parameters.keys();

        if (keys != null) {
            for (String key : keys) {
                mRawParams.setObject(key, parameters.getObject(key));
            }
        }
    }

    public final AVChatParameters setRequestKeys(Set<Key> keys) {
        checkNotNull(keys);

        Set<String> keyName = new HashSet<>(keys.size());
        for (Key key : keys) {
            keyName.add(key.name());
        }
        mRawParams.setRequestKeys(keyName);
        return this;
    }


    public final AVChatParameters setRequestKey(Key key) {
        checkNotNull(key);
        mRawParams.setRequestKey(key.name());
        return this;
    }


    public final boolean getBoolean(Key<Boolean> key) {
        return get(key);
    }

    public final int getInteger(Key<Integer> key) {
        return get(key);
    }

    public final String getString(Key<String> key) {
        return get(key);
    }

    public final void setInteger(Key<Integer> key, int value) {
        set(key, value);
    }

    public final void setBoolean(Key<Boolean> key, boolean value) {
        set(key, value);
    }

    public final void setString(Key<String> key, String value) {
        set(key, value);
    }

    public final boolean containsKey(Key key) {
        checkNotNull(key);
        return mRawParams.containsKey(key.name());
    }

    public final <T> void set(Key<T> key, T value) {
        checkNotNull(key);
        mRawParams.setObject(key.name(), value);
    }

    public final <T> T get(Key<T> key) {
        checkNotNull(key);
        T value = (T) mRawParams.getObject(key.name());
        return value;
    }

    public final void setFloat(Key<Float> key, float value) {
        set(key, value);
    }

    public final float getFloat(Key<Float> key) {
        return get(key);
    }

    public final void removeParameters(Key key) {
        checkNotNull(key);
        mRawParams.removeParameters(key.name());
    }


    private static <T> T checkNotNull(T reference) {
        if (reference == null) {
            throw new NullPointerException();
        }
        return reference;
    }


}