#import "BDSSpeechSynthesizer.h"

+ (BDSSpeechSynthesizer*)sharedInstance;
+ (void)releaseInstance;

/**
 * @brief 设置合成器代理
 * @param delegate 代理对象，负责处理合成器各类事件
 */
- (void)setSynthesizerDelegate: (id<BDSSpeechSynthesizerDelegate>)delegate;

/**
 * @brief 合成器参数设置接口
 * @param param 参数对应的值
 * @param key 合成器预定义的参数名称，参见附录及头文件BDSSpeechSynthesizerParams.h.
 */
-(NSError*)setSynthParam:(id)param forKey:(BDSSynthesizerParamKey)key;

/**
 * @brief 获取合成器参数
 * @param key 合成器预定义的参数名称
 * @param err 如果不为nil，返回错误信息
 * @return 当前使用的参数值
 */
-(id)getSynthParamforKey:(BDSSynthesizerParamKey)key withError:(NSError**)err;

/**
 * @brief 为在线合成设置认证信息
 * @param apiKey 在百度开发者中心注册应用获得
 * @param secretKey 在百度开发者中心注册应用获得
 */
- (void)setApiKey:(NSString *)apiKey withSecretKey:(NSString *)secretKey;

/**
 * @brief 指定SDK工作队列，默认值为main queue (dispatch_get_main_queue())
 * @param callbackQueue 串行队列
 * @return 错误信息，成功返回nil
 */
-(NSError*)setSDKCallbackQueue:(dispatch_queue_t)callbackQueue;

-(dispatch_queue_t)getCurrentCallbackQueue;

/**
 * @brief 加载合成引擎
 * @param textDatFilePath 文本分析数据文件路径
 * @param speechDataPath 声学模型数据文件路径
 * @param licenseFilePath 授权文件路径，如果没有本地授权可传入nil
 * @param appCode 用户持有的授权app code， 即APPID
 * @return 错误码, 成功返回nil
 */
- (NSError*)loadOfflineEngine: (NSString*)textDatFilePath
               speechDataPath: (NSString*)speechDatFilePath
              licenseFilePath: (NSString*)licenseFilePath
                  withAppCode: (NSString*)appCode;

/**
 * @brief 加载合成引擎 注意：用上面的方法加载中英文混合模型不用调用此方法
 * @param textDatFilePath 文本分析数据文件路径
 * @param speechDataPath 声学模型数据文件路径
 * @return 错误码, 成功返回nil
 */
-(NSError*)loadEnglishDataForOfflineEngine: (NSString*)textDataPath
                                speechData: (NSString*)speechDataPath;

/**
 * @brief 重新加载文本分析数据文件或者声学模型数据文件
 * @param datFilePath: 数据文件路径
 * @return 错误码, 成功返回nil
 */
- (NSError*)reinitOfflineEngineData: (NSString*)datFilePath;

/**
 * @brief 加载定制库，加载离线引擎后方可调用该接口
 * @param datFilePath 定制库路径
 * @return 错误码, 成功返回nil
 */
- (NSError*)loadDomainDataForOfflineEngine:(NSString*)datFilePath;

/**
 * @brief 卸载定制库
 * @return 错误码, 成功返回nil
 */
- (NSError*)unloadDomainDataFromOfflineEngine;

/**
 * @brief 验证音库文件的有效性
 * @param datFilePath data文件路径
 * @param err 如果验证失败, 返回错误信息
 * @return 验证成功YES，失败NO
 */
- (BOOL)verifyDataFile: (NSString*) datFilePath error:(NSError**)err;

/**
 * @brief 获取音库文件相关参数
 * @param datFilePath data文件路径
 * @param paramType 参数类型
 * @param paramValue 传出对应参数的值
 * @param err 如果失败, 返回错误信息
 * @return 成功YES，失败NO
 */
- (BOOL)getDataFileParam: (NSString*)datFilePath
                    type: (TTSDataParam)paramType
                   value: (NSString**)paramValue
                   error: (NSError**)err;

/**
 * @brief 合成并朗读文本
 * @param sentence 待合成文本
 * @param err 如果出错，返回错误信息
 * @return 语句ID或-1，如果返回-1，可以从err中获取错误详细信息 
 */
-(NSInteger) speakSentence:(NSString*)sentence withError:(NSError**)err;

/**
 * @brief 合成不朗读文本
 * @param sentence 待合成文本
 * @param err 如果出错，返回错误信息
 * @return 语句ID或-1，如果返回-1，可以从err中获取错误详细信息
 */
-(NSInteger) synthesizeSentence:(NSString*)sentence withError:(NSError**)err;

- (void)cancel;

- (BDSSynthesizerStatus)pause;

- (BDSSynthesizerStatus)resume;

- (BDSSynthesizerStatus)synthesizerStatus;

/**
 * @brief 获取待播放语句数量，包括未合成语句
 */
-(NSInteger)RemainingPlaybackSentenceCount;

-(NSInteger)RemainingSynthesizeSentenceCount;

/**
 * @brief 设置播放器音量
 * @param volume 音量值，[0, 1]
 */
- (void)setPlayerVolume:(float)volume;

/**
 * @brief 设置AudioSessionCategory类型
 * @param category AudioSessionCategory类型，取值参见AVAudioSession Class Reference
 * Default: AVAudioSessionCategoryPlayback
 */
- (void)setAudioSessionCategory:(NSString *)category;

+ (void)setLogLevel:(BDSLogLevel)logLevel;
+ (BDSLogLevel)logLevel;

/**
 * @brief SDK版本信息，包含离线引擎版本信息
 */
+ (NSString *)version;

/**
 * @brief 开始合成新的语句
 * @param SynthesizeSentence 语句对应的ID，该值为合成接口的返回值
 */
- (void)synthesizerStartWorkingSentence:(NSInteger)SynthesizeSentence;

/**
 * @brief 结束合成某个语句
 * @param SynthesizeSentence 语句对应的ID，该值为合成接口的返回值
 */
- (void)synthesizerFinishWorkingSentence:(NSInteger)SynthesizeSentence;

/**
 * @brief 开始朗读某个语句，如果调用纯合成接口，不会触发该回调
 * @param SpeakSentence 语句对应的ID，该值为合成接口的返回值
 */
- (void)synthesizerSpeechStartSentence:(NSInteger)SpeakSentence;

/**
 * @brief 朗读完成，如果调用纯合成接口，不会触发该回调
 * @param SpeakSentence 语句对应的ID，该值为合成接口的返回值
 */
- (void)synthesizerSpeechEndSentence:(NSInteger)SpeakSentence;

/**
 * @brief 新的语音数据已经合成
 * @param newData 语音数据
 * @param fmt 缓存中的音频格式
 * @param newLength 当前语句已合成字符数
 * @param SynthesizeSentence 语句对应的ID，该值为合成接口的返回值
 */
- (void)synthesizerNewDataArrived:(NSData *)newData
                       DataFormat:(BDSAudioFormat)fmt
                   characterCount:(int)newLength
                   sentenceNumber:(NSInteger)SynthesizeSentence;

/**
 * @brief 播放进度变更，返回当前语句已播放字符数，如果调用纯合成接口，不会触发该回调
 * @param newLength 当前语句已播放字符数，非精确值
 * @param SpeakSentence 语句对应的ID，该值为合成接口的返回值
 */
- (void)synthesizerTextSpeakLengthChanged:(int)newLength
                           sentenceNumber:(NSInteger)SpeakSentence;

/**
 * @brief 合成器发生错误
 * @param error 错误对象，包含错误信息
 * @param SpeakSentence 正在播放的语句对应的ID，该值为合成接口的返回值
 * @param SynthesizeSentence 正在合成的语句对应的ID
 */
- (void)synthesizerErrorOccurred:(NSError *)error
                        speaking:(NSInteger)SpeakSentence
                    synthesizing:(NSInteger)SynthesizeSentence;