1 /* 2 * Copyright (c) 2016 The ZLMediaKit project authors. All Rights Reserved. 3 * 4 * This file is part of ZLMediaKit(https://github.com/xia-chu/ZLMediaKit). 5 * 6 * Use of this source code is governed by MIT license that can be found in the 7 * LICENSE file in the root of the source tree. All contributing project authors 8 * may be found in the AUTHORS file in the root of the source tree. 9 */ 10 11 #ifndef MK_EVENT_OBJECTS_H 12 #define MK_EVENT_OBJECTS_H 13 #include "mk_common.h" 14 #include "mk_tcp.h" 15 #ifdef __cplusplus 16 extern "C" { 17 #endif 18 19 ///////////////////////////////////////////MP4Info///////////////////////////////////////////// 20 //MP4Info对象的C映射 21 typedef void* mk_mp4_info; 22 // GMT 标准时间，单位秒 23 API_EXPORT uint64_t API_CALL mk_mp4_info_get_start_time(const mk_mp4_info ctx); 24 // 录像长度，单位秒 25 API_EXPORT float API_CALL mk_mp4_info_get_time_len(const mk_mp4_info ctx); 26 // 文件大小，单位 BYTE 27 API_EXPORT size_t API_CALL mk_mp4_info_get_file_size(const mk_mp4_info ctx); 28 // 文件路径 29 API_EXPORT const char* API_CALL mk_mp4_info_get_file_path(const mk_mp4_info ctx); 30 // 文件名称 31 API_EXPORT const char* API_CALL mk_mp4_info_get_file_name(const mk_mp4_info ctx); 32 // 文件夹路径 33 API_EXPORT const char* API_CALL mk_mp4_info_get_folder(const mk_mp4_info ctx); 34 // 播放路径 35 API_EXPORT const char* API_CALL mk_mp4_info_get_url(const mk_mp4_info ctx); 36 // 应用名称 37 API_EXPORT const char* API_CALL mk_mp4_info_get_vhost(const mk_mp4_info ctx); 38 // 流 ID 39 API_EXPORT const char* API_CALL mk_mp4_info_get_app(const mk_mp4_info ctx); 40 // 虚拟主机 41 API_EXPORT const char* API_CALL mk_mp4_info_get_stream(const mk_mp4_info ctx); 42 43 ///////////////////////////////////////////Parser///////////////////////////////////////////// 44 //Parser对象的C映射 45 typedef void* mk_parser; 46 //Parser::Method(),获取命令字，譬如GET/POST 47 API_EXPORT const char* API_CALL mk_parser_get_method(const mk_parser ctx); 48 //Parser::Url(),获取HTTP的访问url(不包括?后面的参数) 49 API_EXPORT const char* API_CALL mk_parser_get_url(const mk_parser ctx); 50 //Parser::Params(),?后面的参数字符串 51 API_EXPORT const char* API_CALL mk_parser_get_url_params(const mk_parser ctx); 52 //Parser::getUrlArgs()["key"],获取?后面的参数中的特定参数 53 API_EXPORT const char* API_CALL mk_parser_get_url_param(const mk_parser ctx,const char *key); 54 //Parser::Tail()，获取协议相关信息，譬如 HTTP/1.1 55 API_EXPORT const char* API_CALL mk_parser_get_tail(const mk_parser ctx); 56 //Parser::getValues()["key"],获取HTTP头中特定字段 57 API_EXPORT const char* API_CALL mk_parser_get_header(const mk_parser ctx,const char *key); 58 //Parser::Content(),获取HTTP body 59 API_EXPORT const char* API_CALL mk_parser_get_content(const mk_parser ctx, size_t *length); 60 61 ///////////////////////////////////////////MediaInfo///////////////////////////////////////////// 62 //MediaInfo对象的C映射 63 typedef void* mk_media_info; 64 //MediaInfo::_param_strs 65 API_EXPORT const char* API_CALL mk_media_info_get_params(const mk_media_info ctx); 66 //MediaInfo::_schema 67 API_EXPORT const char* API_CALL mk_media_info_get_schema(const mk_media_info ctx); 68 //MediaInfo::_vhost 69 API_EXPORT const char* API_CALL mk_media_info_get_vhost(const mk_media_info ctx); 70 //MediaInfo::_app 71 API_EXPORT const char* API_CALL mk_media_info_get_app(const mk_media_info ctx); 72 //MediaInfo::_streamid 73 API_EXPORT const char* API_CALL mk_media_info_get_stream(const mk_media_info ctx); 74 //MediaInfo::_host 75 API_EXPORT const char* API_CALL mk_media_info_get_host(const mk_media_info ctx); 76 //MediaInfo::_port 77 API_EXPORT uint16_t API_CALL mk_media_info_get_port(const mk_media_info ctx); 78 79 80 ///////////////////////////////////////////MediaSource///////////////////////////////////////////// 81 //MediaSource对象的C映射 82 typedef void* mk_media_source; 83 //查找MediaSource的回调函数 84 typedef void(API_CALL *on_mk_media_source_find_cb)(void *user_data, const mk_media_source ctx); 85 86 //MediaSource::getSchema() 87 API_EXPORT const char* API_CALL mk_media_source_get_schema(const mk_media_source ctx); 88 //MediaSource::getVhost() 89 API_EXPORT const char* API_CALL mk_media_source_get_vhost(const mk_media_source ctx); 90 //MediaSource::getApp() 91 API_EXPORT const char* API_CALL mk_media_source_get_app(const mk_media_source ctx); 92 //MediaSource::getId() 93 API_EXPORT const char* API_CALL mk_media_source_get_stream(const mk_media_source ctx); 94 //MediaSource::readerCount() 95 API_EXPORT int API_CALL mk_media_source_get_reader_count(const mk_media_source ctx); 96 //MediaSource::totalReaderCount() 97 API_EXPORT int API_CALL mk_media_source_get_total_reader_count(const mk_media_source ctx); 98 /** 99 * 直播源在ZLMediaKit中被称作为MediaSource， 100 * 目前支持3种，分别是RtmpMediaSource、RtspMediaSource、HlsMediaSource 101 * 源的产生有被动和主动方式: 102 * 被动方式分别是rtsp/rtmp/rtp推流、mp4点播 103 * 主动方式包括mk_media_create创建的对象(DevChannel)、mk_proxy_player_create创建的对象(PlayerProxy) 104 * 被动方式你不用做任何处理，ZLMediaKit已经默认适配了MediaSource::close()事件，都会关闭直播流 105 * 主动方式你要设置这个事件的回调，你要自己选择删除对象 106 * 通过mk_proxy_player_set_on_close、mk_media_set_on_close函数可以设置回调, 107 * 请在回调中删除对象来完成媒体的关闭，否则又为什么要调用mk_media_source_close函数？ 108 * @param ctx 对象 109 * @param force 是否强制关闭，如果强制关闭，在有人观看的情况下也会关闭 110 * @return 0代表失败，1代表成功 111 */ 112 API_EXPORT int API_CALL mk_media_source_close(const mk_media_source ctx,int force); 113 //MediaSource::seekTo() 114 API_EXPORT int API_CALL mk_media_source_seek_to(const mk_media_source ctx,uint32_t stamp); 115 116 /** 117 * rtp推流成功与否的回调(第一次成功后，后面将一直重试) 118 */ 119 typedef void(API_CALL *on_mk_media_source_send_rtp_result)(void *user_data, uint16_t local_port, int err, const char *msg); 120 121 //MediaSource::startSendRtp,请参考mk_media_start_send_rtp,注意ctx参数类型不一样 122 API_EXPORT void API_CALL mk_media_source_start_send_rtp(const mk_media_source ctx, const char *dst_url, uint16_t dst_port, const char *ssrc, int is_udp, on_mk_media_source_send_rtp_result cb, void *user_data); 123 //MediaSource::stopSendRtp，请参考mk_media_stop_send_rtp,注意ctx参数类型不一样 124 API_EXPORT int API_CALL mk_media_source_stop_send_rtp(const mk_media_source ctx); 125 126 //MediaSource::find() 127 API_EXPORT void API_CALL mk_media_source_find(const char *schema, 128 const char *vhost, 129 const char *app, 130 const char *stream, 131 int from_mp4, 132 void *user_data, 133 on_mk_media_source_find_cb cb); 134 //MediaSource::for_each_media() 135 API_EXPORT void API_CALL mk_media_source_for_each(void *user_data, on_mk_media_source_find_cb cb, const char *schema, 136 const char *vhost, const char *app, const char *stream); 137 138 ///////////////////////////////////////////HttpBody///////////////////////////////////////////// 139 //HttpBody对象的C映射 140 typedef void* mk_http_body; 141 /** 142 * 生成HttpStringBody 143 * @param str 字符串指针 144 * @param len 字符串长度，为0则用strlen获取 145 */ 146 API_EXPORT mk_http_body API_CALL mk_http_body_from_string(const char *str,size_t len); 147 148 /** 149 * 生成HttpFileBody 150 * @param file_path 文件完整路径 151 */ 152 API_EXPORT mk_http_body API_CALL mk_http_body_from_file(const char *file_path); 153 154 /** 155 * 生成HttpMultiFormBody 156 * @param key_val 参数key-value 157 * @param file_path 文件完整路径 158 */ 159 API_EXPORT mk_http_body API_CALL mk_http_body_from_multi_form(const char *key_val[],const char *file_path); 160 161 /** 162 * 销毁HttpBody 163 */ 164 API_EXPORT void API_CALL mk_http_body_release(mk_http_body ctx); 165 166 ///////////////////////////////////////////HttpResponseInvoker///////////////////////////////////////////// 167 //HttpSession::HttpResponseInvoker对象的C映射 168 typedef void* mk_http_response_invoker; 169 170 /** 171 * HttpSession::HttpResponseInvoker(const string &codeOut, const StrCaseMap &headerOut, const HttpBody::Ptr &body); 172 * @param response_code 譬如200 173 * @param response_header 返回的http头，譬如 {"Content-Type","text/html",NULL} 必须以NULL结尾 174 * @param response_body body对象 175 */ 176 API_EXPORT void API_CALL mk_http_response_invoker_do(const mk_http_response_invoker ctx, 177 int response_code, 178 const char **response_header, 179 const mk_http_body response_body); 180 181 /** 182 * HttpSession::HttpResponseInvoker(const string &codeOut, const StrCaseMap &headerOut, const string &body); 183 * @param response_code 譬如200 184 * @param response_header 返回的http头，譬如 {"Content-Type","text/html",NULL} 必须以NULL结尾 185 * @param response_content 返回的content部分，譬如一个网页内容 186 */ 187 API_EXPORT void API_CALL mk_http_response_invoker_do_string(const mk_http_response_invoker ctx, 188 int response_code, 189 const char **response_header, 190 const char *response_content); 191 /** 192 * HttpSession::HttpResponseInvoker(const StrCaseMap &requestHeader,const StrCaseMap &responseHeader,const string &filePath); 193 * @param request_parser 请求事件中的mk_parser对象，用于提取其中http头中的Range字段，通过该字段先fseek然后再发送文件部分片段 194 * @param response_header 返回的http头，譬如 {"Content-Type","text/html",NULL} 必须以NULL结尾 195 * @param response_file_path 返回的content部分，譬如/path/to/html/file 196 */ 197 API_EXPORT void API_CALL mk_http_response_invoker_do_file(const mk_http_response_invoker ctx, 198 const mk_parser request_parser, 199 const char *response_header[], 200 const char *response_file_path); 201 /** 202 * 克隆mk_http_response_invoker对象，通过克隆对象为堆对象，可以实现跨线程异步执行mk_http_response_invoker_do 203 * 如果是同步执行mk_http_response_invoker_do，那么没必要克隆对象 204 */ 205 API_EXPORT mk_http_response_invoker API_CALL mk_http_response_invoker_clone(const mk_http_response_invoker ctx); 206 207 /** 208 * 销毁堆上的克隆对象 209 */ 210 API_EXPORT void API_CALL mk_http_response_invoker_clone_release(const mk_http_response_invoker ctx); 211 212 ///////////////////////////////////////////HttpAccessPathInvoker///////////////////////////////////////////// 213 //HttpSession::HttpAccessPathInvoker对象的C映射 214 typedef void* mk_http_access_path_invoker; 215 /** 216 * HttpSession::HttpAccessPathInvoker(const string &errMsg,const string &accessPath, int cookieLifeSecond); 217 * @param err_msg 如果为空，则代表鉴权通过，否则为错误提示,可以为null 218 * @param access_path 运行或禁止访问的根目录,可以为null 219 * @param cookie_life_second 鉴权cookie有效期 220 **/ 221 API_EXPORT void API_CALL mk_http_access_path_invoker_do(const mk_http_access_path_invoker ctx, 222 const char *err_msg, 223 const char *access_path, 224 int cookie_life_second); 225 226 /** 227 * 克隆mk_http_access_path_invoker对象，通过克隆对象为堆对象，可以实现跨线程异步执行mk_http_access_path_invoker_do 228 * 如果是同步执行mk_http_access_path_invoker_do，那么没必要克隆对象 229 */ 230 API_EXPORT mk_http_access_path_invoker API_CALL mk_http_access_path_invoker_clone(const mk_http_access_path_invoker ctx); 231 232 /** 233 * 销毁堆上的克隆对象 234 */ 235 API_EXPORT void API_CALL mk_http_access_path_invoker_clone_release(const mk_http_access_path_invoker ctx); 236 237 ///////////////////////////////////////////RtspSession::onGetRealm///////////////////////////////////////////// 238 //RtspSession::onGetRealm对象的C映射 239 typedef void* mk_rtsp_get_realm_invoker; 240 /** 241 * 执行RtspSession::onGetRealm 242 * @param realm 该rtsp流是否需要开启rtsp专属鉴权，至null或空字符串则不鉴权 243 */ 244 API_EXPORT void API_CALL mk_rtsp_get_realm_invoker_do(const mk_rtsp_get_realm_invoker ctx, 245 const char *realm); 246 247 /** 248 * 克隆mk_rtsp_get_realm_invoker对象，通过克隆对象为堆对象，可以实现跨线程异步执行mk_rtsp_get_realm_invoker_do 249 * 如果是同步执行mk_rtsp_get_realm_invoker_do，那么没必要克隆对象 250 */ 251 API_EXPORT mk_rtsp_get_realm_invoker API_CALL mk_rtsp_get_realm_invoker_clone(const mk_rtsp_get_realm_invoker ctx); 252 253 /** 254 * 销毁堆上的克隆对象 255 */ 256 API_EXPORT void API_CALL mk_rtsp_get_realm_invoker_clone_release(const mk_rtsp_get_realm_invoker ctx); 257 258 ///////////////////////////////////////////RtspSession::onAuth///////////////////////////////////////////// 259 //RtspSession::onAuth对象的C映射 260 typedef void* mk_rtsp_auth_invoker; 261 262 /** 263 * 执行RtspSession::onAuth 264 * @param encrypted 为true是则表明是md5加密的密码，否则是明文密码, 在请求明文密码时如果提供md5密码者则会导致认证失败 265 * @param pwd_or_md5 明文密码或者md5加密的密码 266 */ 267 API_EXPORT void API_CALL mk_rtsp_auth_invoker_do(const mk_rtsp_auth_invoker ctx, 268 int encrypted, 269 const char *pwd_or_md5); 270 271 /** 272 * 克隆mk_rtsp_auth_invoker对象，通过克隆对象为堆对象，可以实现跨线程异步执行mk_rtsp_auth_invoker_do 273 * 如果是同步执行mk_rtsp_auth_invoker_do，那么没必要克隆对象 274 */ 275 API_EXPORT mk_rtsp_auth_invoker API_CALL mk_rtsp_auth_invoker_clone(const mk_rtsp_auth_invoker ctx); 276 277 /** 278 * 销毁堆上的克隆对象 279 */ 280 API_EXPORT void API_CALL mk_rtsp_auth_invoker_clone_release(const mk_rtsp_auth_invoker ctx); 281 282 ///////////////////////////////////////////Broadcast::PublishAuthInvoker///////////////////////////////////////////// 283 //Broadcast::PublishAuthInvoker对象的C映射 284 typedef void* mk_publish_auth_invoker; 285 286 /** 287 * 执行Broadcast::PublishAuthInvoker 288 * @param err_msg 为空或null则代表鉴权成功 289 * @param enable_hls 是否允许转换hls 290 * @param enable_mp4 是否运行MP4录制 291 */ 292 API_EXPORT void API_CALL mk_publish_auth_invoker_do(const mk_publish_auth_invoker ctx, 293 const char *err_msg, 294 int enable_hls, 295 int enable_mp4); 296 297 /** 298 * 克隆mk_publish_auth_invoker对象，通过克隆对象为堆对象，可以实现跨线程异步执行mk_publish_auth_invoker_do 299 * 如果是同步执行mk_publish_auth_invoker_do，那么没必要克隆对象 300 */ 301 API_EXPORT mk_publish_auth_invoker API_CALL mk_publish_auth_invoker_clone(const mk_publish_auth_invoker ctx); 302 303 /** 304 * 销毁堆上的克隆对象 305 */ 306 API_EXPORT void API_CALL mk_publish_auth_invoker_clone_release(const mk_publish_auth_invoker ctx); 307 308 ///////////////////////////////////////////Broadcast::AuthInvoker///////////////////////////////////////////// 309 //Broadcast::AuthInvoker对象的C映射 310 typedef void* mk_auth_invoker; 311 312 /** 313 * 执行Broadcast::AuthInvoker 314 * @param err_msg 为空或null则代表鉴权成功 315 */ 316 API_EXPORT void API_CALL mk_auth_invoker_do(const mk_auth_invoker ctx, const char *err_msg); 317 318 /** 319 * 克隆mk_auth_invoker对象，通过克隆对象为堆对象，可以实现跨线程异步执行mk_auth_invoker_do 320 * 如果是同步执行mk_auth_invoker_do，那么没必要克隆对象 321 */ 322 API_EXPORT mk_auth_invoker API_CALL mk_auth_invoker_clone(const mk_auth_invoker ctx); 323 324 /** 325 * 销毁堆上的克隆对象 326 */ 327 API_EXPORT void API_CALL mk_auth_invoker_clone_release(const mk_auth_invoker ctx); 328 329 #ifdef __cplusplus 330 } 331 #endif 332 #endif //MK_EVENT_OBJECTS_H 333