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_MEDIA_H_ 12 #define MK_MEDIA_H_ 13 14 #include "mk_common.h" 15 #include "mk_track.h" 16 #include "mk_frame.h" 17 #include "mk_events_objects.h" 18 #include "mk_thread.h" 19 20 #ifdef __cplusplus 21 extern "C" { 22 #endif 23 24 typedef void *mk_media; 25 26 /** 27 * 创建一个媒体源 28 * @param vhost 虚拟主机名，一般为__defaultVhost__ 29 * @param app 应用名，推荐为live 30 * @param stream 流id，例如camera 31 * @param duration 时长(单位秒)，直播则为0 32 * @param hls_enabled 是否生成hls 33 * @param mp4_enabled 是否生成mp4 34 * @return 对象指针 35 */ 36 API_EXPORT mk_media API_CALL mk_media_create(const char *vhost, const char *app, const char *stream, 37 float duration, int hls_enabled, int mp4_enabled); 38 39 /** 40 * 销毁媒体源 41 * @param ctx 对象指针 42 */ 43 API_EXPORT void API_CALL mk_media_release(mk_media ctx); 44 45 /** 46 * 添加音视频track 47 * @param ctx mk_media对象 48 * @param track mk_track对象，音视频轨道 49 */ 50 API_EXPORT void API_CALL mk_media_init_track(mk_media ctx, mk_track track); 51 52 /** 53 * 添加视频轨道，请改用mk_media_init_track方法 54 * @param ctx 对象指针 55 * @param codec_id 0:CodecH264/1:CodecH265 56 * @param width 视频宽度; 在编码时才有效 57 * @param height 视频高度; 在编码时才有效 58 * @param fps 视频fps; 在编码时才有效 59 * @param bit_rate 视频比特率,单位bps; 在编码时才有效 60 * @param width 视频宽度 61 * @param height 视频高度 62 * @param fps 视频fps 63 * @return 1代表成功，0失败 64 */ 65 API_EXPORT int API_CALL mk_media_init_video(mk_media ctx, int codec_id, int width, int height, float fps, int bit_rate); 66 67 /** 68 * 添加音频轨道，请改用mk_media_init_track方法 69 * @param ctx 对象指针 70 * @param codec_id 2:CodecAAC/3:CodecG711A/4:CodecG711U/5:OPUS 71 * @param channel 通道数 72 * @param sample_bit 采样位数，只支持16 73 * @param sample_rate 采样率 74 * @return 1代表成功，0失败 75 */ 76 API_EXPORT int API_CALL mk_media_init_audio(mk_media ctx, int codec_id, int sample_rate, int channels, int sample_bit); 77 78 /** 79 * 初始化h264/h265/aac完毕后调用此函数， 80 * 在单track(只有音频或视频)时，因为ZLMediaKit不知道后续是否还要添加track，所以会多等待3秒钟 81 * 如果产生的流是单Track类型，请调用此函数以便加快流生成速度，当然不调用该函数，影响也不大(会多等待3秒) 82 * @param ctx 对象指针 83 */ 84 API_EXPORT void API_CALL mk_media_init_complete(mk_media ctx); 85 86 /** 87 * 输入frame对象 88 * @param ctx mk_media对象 89 * @param frame 帧对象 90 * @return 1代表成功，0失败 91 */ 92 API_EXPORT int API_CALL mk_media_input_frame(mk_media ctx, mk_frame frame); 93 94 /** 95 * 输入单帧H264视频，帧起始字节00 00 01,00 00 00 01均可，请改用mk_media_input_frame方法 96 * @param ctx 对象指针 97 * @param data 单帧H264数据 98 * @param len 单帧H264数据字节数 99 * @param dts 解码时间戳，单位毫秒 100 * @param pts 播放时间戳，单位毫秒 101 * @return 1代表成功，0失败 102 */ 103 API_EXPORT int API_CALL mk_media_input_h264(mk_media ctx, const void *data, int len, uint64_t dts, uint64_t pts); 104 105 /** 106 * 输入单帧H265视频，帧起始字节00 00 01,00 00 00 01均可，请改用mk_media_input_frame方法 107 * @param ctx 对象指针 108 * @param data 单帧H265数据 109 * @param len 单帧H265数据字节数 110 * @param dts 解码时间戳，单位毫秒 111 * @param pts 播放时间戳，单位毫秒 112 * @return 1代表成功，0失败 113 */ 114 API_EXPORT int API_CALL mk_media_input_h265(mk_media ctx, const void *data, int len, uint64_t dts, uint64_t pts); 115 116 /** 117 * 输入YUV视频数据 118 * @param ctx 对象指针 119 * @param yuv yuv420p数据 120 * @param linesize yuv420p linesize 121 * @param cts 视频采集时间戳，单位毫秒 122 */ 123 API_EXPORT void API_CALL mk_media_input_yuv(mk_media ctx, const char *yuv[3], int linesize[3], uint64_t cts); 124 125 /** 126 * 输入单帧AAC音频(单独指定adts头)，请改用mk_media_input_frame方法 127 * @param ctx 对象指针 128 * @param data 不包含adts头的单帧AAC数据，adts头7个字节 129 * @param len 单帧AAC数据字节数 130 * @param dts 时间戳，毫秒 131 * @param adts adts头，可以为null 132 * @return 1代表成功，0失败 133 */ 134 API_EXPORT int API_CALL mk_media_input_aac(mk_media ctx, const void *data, int len, uint64_t dts, void *adts); 135 136 /** 137 * 输入单帧PCM音频,启用ENABLE_FAAC编译时，该函数才有效 138 * @param ctx 对象指针 139 * @param data 单帧PCM数据 140 * @param len 单帧PCM数据字节数 141 * @param dts 时间戳，毫秒 142 * @return 1代表成功，0失败 143 */ 144 API_EXPORT int API_CALL mk_media_input_pcm(mk_media ctx, void *data, int len, uint64_t pts); 145 146 /** 147 * 输入单帧OPUS/G711音频帧，请改用mk_media_input_frame方法 148 * @param ctx 对象指针 149 * @param data 单帧音频数据 150 * @param len 单帧音频数据字节数 151 * @param dts 时间戳，毫秒 152 * @return 1代表成功，0失败 153 */ 154 API_EXPORT int API_CALL mk_media_input_audio(mk_media ctx, const void* data, int len, uint64_t dts); 155 156 /** 157 * MediaSource.close()回调事件 158 * 在选择关闭一个关联的MediaSource时，将会最终触发到该回调 159 * 你应该通过该事件调用mk_media_release函数并且释放其他资源 160 * 如果你不调用mk_media_release函数，那么MediaSource.close()操作将无效 161 * @param user_data 用户数据指针，通过mk_media_set_on_close函数设置 162 */ 163 typedef void(API_CALL *on_mk_media_close)(void *user_data); 164 165 /** 166 * 监听MediaSource.close()事件 167 * 在选择关闭一个关联的MediaSource时，将会最终触发到该回调 168 * 你应该通过该事件调用mk_media_release函数并且释放其他资源 169 * @param ctx 对象指针 170 * @param cb 回调指针 171 * @param user_data 用户数据指针 172 */ 173 API_EXPORT void API_CALL mk_media_set_on_close(mk_media ctx, on_mk_media_close cb, void *user_data); 174 175 /** 176 * 收到客户端的seek请求时触发该回调 177 * @param user_data 用户数据指针,通过mk_media_set_on_seek设置 178 * @param stamp_ms seek至的时间轴位置，单位毫秒 179 * @return 1代表将处理seek请求，0代表忽略该请求 180 */ 181 typedef int(API_CALL *on_mk_media_seek)(void *user_data,uint32_t stamp_ms); 182 183 /** 184 * 收到客户端的pause或resume请求时触发该回调 185 * @param user_data 用户数据指针,通过mk_media_set_on_pause设置 186 * @param pause 1:暂停, 0: 恢复 187 */ 188 typedef int(API_CALL* on_mk_media_pause)(void* user_data, int pause); 189 190 /** 191 * 收到客户端的speed请求时触发该回调 192 * @param user_data 用户数据指针,通过mk_media_set_on_pause设置 193 * @param speed 0.5 1.0 2.0 194 */ 195 typedef int(API_CALL* on_mk_media_speed)(void* user_data, float speed); 196 197 /** 198 * 监听播放器seek请求事件 199 * @param ctx 对象指针 200 * @param cb 回调指针 201 * @param user_data 用户数据指针 202 */ 203 API_EXPORT void API_CALL mk_media_set_on_seek(mk_media ctx, on_mk_media_seek cb, void *user_data); 204 205 /** 206 * 监听播放器pause请求事件 207 * @param ctx 对象指针 208 * @param cb 回调指针 209 * @param user_data 用户数据指针 210 */ 211 API_EXPORT void API_CALL mk_media_set_on_pause(mk_media ctx, on_mk_media_pause cb, void* user_data); 212 213 /** 214 * 监听播放器pause请求事件 215 * @param ctx 对象指针 216 * @param cb 回调指针 217 * @param user_data 用户数据指针 218 */ 219 API_EXPORT void API_CALL mk_media_set_on_speed(mk_media ctx, on_mk_media_speed cb, void* user_data); 220 221 /** 222 * 获取总的观看人数 223 * @param ctx 对象指针 224 * @return 观看人数 225 */ 226 API_EXPORT int API_CALL mk_media_total_reader_count(mk_media ctx); 227 228 /** 229 * 生成的MediaSource注册或注销事件 230 * @param user_data 设置回调时的用户数据指针 231 * @param sender 生成的MediaSource对象 232 * @param regist 1为注册事件，0为注销事件 233 */ 234 typedef void(API_CALL *on_mk_media_source_regist)(void *user_data, mk_media_source sender, int regist); 235 236 /** 237 * 设置MediaSource注册或注销事件回调函数 238 * @param ctx 对象指针 239 * @param cb 回调指针 240 * @param user_data 用户数据指针 241 */ 242 API_EXPORT void API_CALL mk_media_set_on_regist(mk_media ctx, on_mk_media_source_regist cb, void *user_data); 243 244 /** 245 * rtp推流成功与否的回调(第一次成功后，后面将一直重试) 246 */ 247 typedef on_mk_media_source_send_rtp_result on_mk_media_send_rtp_result; 248 249 /** 250 * 开始发送一路ps-rtp流(通过ssrc区分多路)，此api线程安全 251 * @param ctx 对象指针 252 * @param dst_url 目标ip或域名 253 * @param dst_port 目标端口 254 * @param ssrc rtp的ssrc，10进制的字符串打印 255 * @param is_udp 是否为udp 256 * @param cb 启动成功或失败回调 257 * @param user_data 回调用户指针 258 */ 259 API_EXPORT void API_CALL mk_media_start_send_rtp(mk_media ctx, const char *dst_url, uint16_t dst_port, const char *ssrc, int is_udp, on_mk_media_send_rtp_result cb, void *user_data); 260 261 /** 262 * 停止某路或全部ps-rtp发送，此api线程安全 263 * @param ctx 对象指针 264 * @param ssrc rtp的ssrc，10进制的字符串打印，如果为null或空字符串，则停止所有rtp推流 265 */ 266 API_EXPORT void API_CALL mk_media_stop_send_rtp(mk_media ctx, const char *ssrc); 267 268 /** 269 * 获取所属线程 270 * @param ctx 对象指针 271 */ 272 API_EXPORT mk_thread API_CALL mk_media_get_owner_thread(mk_media ctx); 273 274 275 #ifdef __cplusplus 276 } 277 #endif 278 279 #endif /* MK_MEDIA_H_ */ 280