/*
 * Module:   TXLivePushConfig @ TXLiteAVSDK
 * 
 * Function: 腾讯云直播推流用 RTMP SDK 的参数配置模块
 *
 * Version: <:Version:>
 */

#import <Foundation/NSObject.h>
#if TARGET_OS_IPHONE
#import <UIKit/UIKit.h>
#endif
#import "TXLiveSDKTypeDef.h"

#define CUSTOM_MODE_AUDIO_CAPTURE                   0X001   ///> 客户自定义音频采集
#define CUSTOM_MODE_VIDEO_CAPTURE                   0X002   ///> 客户自定义视频采集
#define CUSTOM_MODE_AUDIO_PREPROCESS                0X004   ///> 客户自定义音频处理
#define CUSTOM_MODE_VIDEO_PREPROCESS                0X008   ///> 客户自定义视频处理

#define TXRTMPSDK_LINKMIC_STREAMTYPE_MAIN           1       ///> 连麦模式下主播的流
#define TXRTMPSDK_LINKMIC_STREAMTYPE_SUB            2       ///> 连麦模式下连麦观众的流

/**
 * 腾讯云直播推流用 RTMP SDK 的参数配置模块
 *
 * 主要负责 TXLivePusher 对应的参数设置，**其中绝大多数设置项在推流开始之后再设置是无效的**。
 */
@interface TXLivePushConfig : NSObject

/////////////////////////////////////////////////////////////////////////////////
//
//                      常用设置项
//
/////////////////////////////////////////////////////////////////////////////////

///【字段含义】HOME 键所在方向，用来切换横竖屏推流，默认值：HOME_ORIENTATION_DOWN（竖屏推流）。
///【特别说明】常用的还有 HOME_ORIENTATION_RIGHT 和 HOME_ORIENTATION_LEFT，也就是横屏推流。
///            改变该字段的设置以后，本地摄像头的预览画面方向也会发生改变，请调用 TXLivePush 的 setRenderRotation 进行矫正。
@property(nonatomic, assign) int homeOrientation;

///【字段含义】是否允许点击曝光聚焦，默认值：NO。
@property(nonatomic, assign) BOOL touchFocus;

///【字段含义】是否允许双指手势放大预览画面，默认值：NO。
@property(nonatomic, assign) BOOL enableZoom;

///【字段含义】水印图片，设为 nil 等同于关闭水印。
@property(nonatomic, retain) TXImage *watermark;

///【字段含义】水印图片位置，水印大小为图片实际大小，待废弃，推荐使用 watermarkNormalization。
@property(nonatomic, assign) CGPoint watermarkPos;

///【字段含义】水印图片相对于推流分辨率的归一化坐标
///【推荐取值】假设推流分辨率为：540x960，该字段设置为：(0.1，0.1，0.1，0.0)，那么水印的实际像素坐标为：
///           (540 × 0.1, 960 × 0.1, 水印宽度 × 0.1，水印高度会被自动计算）
///【特别说明】watermarkNormalization 的优先级高于 watermarkPos。 
@property(nonatomic, assign) CGRect watermarkNormalization;


/////////////////////////////////////////////////////////////////////////////////
//
//                      垫片推流（App 切后台）
//
/////////////////////////////////////////////////////////////////////////////////

///【字段含义】垫片推流的最大持续时间，单位秒，默认值：300s。
///【特别说明】调用 TXLivePusher 的 pausePush() 接口，会暂停摄像头采集并进入垫片推流状态，如果该状态一直保持，
///          可能会消耗主播过多的手机流量，本字段用于指定垫片推流的最大持续时间，超过后即断开与云服务器的连接。
@property(nonatomic, assign) int pauseTime;

///【字段含义】垫片推流时的视频帧率，取值范围3 - 8，默认值：5 FPS。
@property(nonatomic, assign) int pauseFps;

///【字段含义】垫片推流时使用的图片素材，最大尺寸不能超过1920 x 1920。
@property(nonatomic, retain) TXImage *pauseImg;


/////////////////////////////////////////////////////////////////////////////////
//
//                      音视频编码参数
//
/////////////////////////////////////////////////////////////////////////////////

///【字段含义】视频分辨率，默认值：VIDEO_RESOLUTION_TYPE_360_640。
///【特别说明】推荐直接使用 TXLivePusher 的 setVideoQuality 接口调整画面质量。
@property(nonatomic, assign) int videoResolution;

///【字段含义】视频帧率，默认值：15FPS。
///【特别说明】推荐直接使用 TXLivePusher 的 setVideoQuality 接口调整画面质量。
@property(nonatomic, assign) int videoFPS;

///【字段含义】视频编码 GOP，也就是常说的关键帧间隔，单位：秒；默认值：3s。
///【特别说明】推荐直接使用 TXLivePusher 的 setVideoQuality 接口调整画面质量。
@property(nonatomic, assign) int videoEncodeGop;

///【字段含义】视频编码的平均码率，默认值：700kbps。
///【特别说明】推荐直接使用 TXLivePusher 的 setVideoQuality 接口调整画面质量。
@property(nonatomic, assign) int videoBitratePIN;

///【字段含义】码率自适应开关，开启后，SDK 会根据网络情况自动调节视频码率，调节范围在 (videoBitrateMin - videoBitrateMax)。
///【推荐取值】NO
@property(nonatomic, assign) BOOL enableAutoBitrate;

///【字段含义】码率自适应算法
///【推荐取值】AUTO_ADJUST_BITRATE_STRATEGY_1
@property(nonatomic, assign) int autoAdjustStrategy;

///【字段含义】码率自适应 - 最高码率，默认值：1000kpbs
@property(nonatomic, assign) int videoBitrateMax;

///【字段含义】码率自适应 - 最低码率，默认值：400kpbs
///【推荐取值】不要设置太低的数值，过低的码率会导致运动画面出现大面积马赛克。
@property(nonatomic, assign) int videoBitrateMin;

///【字段含义】音频采样率，采样率越高音质越好，对于有音乐的场景请使用48000的采样率。
///【推荐取值】AUDIO_SAMPLE_RATE_48000
@property(nonatomic, assign) int audioSampleRate;

///【字段含义】音频声道数，默认值：1（单声道）。
@property(nonatomic, assign) int audioChannels;

///【字段含义】是否开启耳返特效
///【推荐取值】NO
///【特别说明】开启耳返会消耗更多的 CPU，只有在主播带耳机唱歌的时候才有必要开启此功能。
@property(nonatomic, assign) BOOL enableAudioPreview;

///【字段含义】是否为纯音频推流
///【推荐取值】NO
///【特别说明】如果希望实现纯音频推流的功能，需要在推流前就设置该参数，否则播放端会有兼容性问题。
@property(nonatomic, assign) BOOL enablePureAudioPush;

/////////////////////////////////////////////////////////////////////////////////
//
//                      网络相关参数
//
/////////////////////////////////////////////////////////////////////////////////

///【字段含义】推流遭遇网络连接断开时 SDK 默认重试的次数，取值范围1 - 10，默认值：3。
@property(nonatomic, assign) int connectRetryCount;

///【字段含义】网络重连的时间间隔，单位秒，取值范围3 - 30，默认值：3。
@property(nonatomic, assign) int connectRetryInterval;

/////////////////////////////////////////////////////////////////////////////////
//
//                      自定义采集和处理
//
/////////////////////////////////////////////////////////////////////////////////

///【字段含义】自定义采集和自定义处理开关
///【特别说明】该字段需要使用与运算符进行级联操作（自定义采集和自定义处理不能同时开启）:
///            开启自定义视频采集：_config.customModeType |= CUSTOM_MODE_VIDEO_CAPTURE；
///            开启自定义音频采集：_config.customModeType |= CUSTOM_MODE_AUDIO_CAPTURE；
@property(nonatomic, assign) int customModeType;

///【字段含义】仅开启自定义采集时有效，用于设置编码分辨率。
///【特别说明】此值设置需与调用 sendVideoSampleBuffer 时传入的 SampleBuffer 的宽高比一致，否则会引起画面变形。
///            如果指定 autoSampleBufferSize 为 YES，则不需要设置该字段。
@property(assign) CGSize sampleBufferSize;

///【字段含义】仅开启自定义采集时有效，YES 代表编码分辨率等于输入的 SampleBuffer 的分辨率，默认值：NO。
@property BOOL autoSampleBufferSize;


/////////////////////////////////////////////////////////////////////////////////
//
//                      专业设置项（慎用）
//
/////////////////////////////////////////////////////////////////////////////////

///【字段含义】是否开启噪声抑制（注意：早期版本引入了拼写错误，考虑到接口兼容一直没有修正，正确拼写应该是 ANS）
///【推荐取值】NO：ANS 对于直播环境中由其它设备外放的音乐是不友好的，通过 playBGM 设置的背景音不受影响。
///【特别说明】如果直播场景只有主播在说话，ANS 有助于让主播的声音更清楚，但如果主播在吹拉弹唱，ANS 会损伤乐器的声音。
@property(nonatomic, assign) BOOL enableNAS;

///【字段含义】是否开启回声抑制
///【推荐取值】NO：回声抑制会启用通话模式音量，导致音质变差，非连麦场景下请不要开启。
///【特别说明】只有在连麦模式下才需要开启 AEC，如果是普通的直播，将主播的手机和观众的手机放在一起所产生的啸叫是正常现象。
@property(nonatomic, assign) BOOL enableAEC;

///【字段含义】开启视频硬件加速， 默认值：YES。
@property(nonatomic, assign) BOOL enableHWAcceleration;

///【字段含义】开启音频硬件加速， 默认值：YES。
@property(nonatomic, assign) BOOL enableAudioAcceleration;



/////////////////////////////////////////////////////////////////////////////////
//
//                      待废弃设置项
//
/////////////////////////////////////////////////////////////////////////////////

///【字段含义】是否前置摄像头，待废弃，建议直接使用 TXLivePusher 的 frontCamera 属性和 switchCamera 函数。
@property(nonatomic, assign) BOOL frontCamera;

///【字段含义】美颜强度，待废弃，建议直接使用 TXLivePusher 的 setBeautyStyle 函数。
@property(nonatomic, assign) float beautyFilterDepth;

///【字段含义】美白强度，待废弃，建议直接使用 TXLivePusher 的 setBeautyStyle 函数。
@property(nonatomic, assign) float whiteningFilterDepth;

///【字段含义】是否开启就近选路，待废弃，默认值：YES。
@property(nonatomic, assign) BOOL enableNearestIP;

///【字段含义】RTMP 传输通道的类型，待废弃，默认值为：AUTO。
@property (nonatomic, assign) int rtmpChannelType;

///【字段含义】自定义 MetaData
/// 以 key，value 方式填入 MetaData，value 只支持字符串类型，最多只支持12组数据
///【特别说明】需要在推流前设置，设置的值放到 RTMP 流的 MetaData 段，播放端收到对应的 MetaData
@property(nonatomic, copy) NSDictionary *metaData;

@end