Fork me on GitHub
utils.h
Go to the documentation of this file.
1
12#ifndef JANUS_UTILS_H
13#define JANUS_UTILS_H
14
15#include <stdint.h>
16#include <glib.h>
17#include <jansson.h>
18
19#define JANUS_JSON_STRING JSON_STRING
20#define JANUS_JSON_INTEGER JSON_INTEGER
21#define JANUS_JSON_OBJECT JSON_OBJECT
22/* Use JANUS_JSON_BOOL instead of the non-existing JSON_BOOLEAN */
23#define JANUS_JSON_BOOL JSON_TRUE
24#define JANUS_JSON_PARAM_REQUIRED 1
25#define JANUS_JSON_PARAM_POSITIVE 2
26#define JANUS_JSON_PARAM_NONEMPTY 4
27
29 const gchar *name;
30 json_type jtype;
31 unsigned int flags;
32};
33
37gint64 janus_get_monotonic_time(void);
38
42gint64 janus_get_real_time(void);
43
50char *janus_string_replace(char *message, const char *old_string, const char *new_string) G_GNUC_WARN_UNUSED_RESULT;
51
57size_t janus_strlcat(char *dest, const char *src, size_t dest_size);
58
62gboolean janus_is_true(const char *value);
63
68gboolean janus_strcmp_const_time(const void *str1, const void *str2);
69
74guint32 janus_random_uint32(void);
75
82guint64 janus_random_uint64_full(void);
83
96guint64 janus_random_uint64(void);
97
102char *janus_random_uuid(void);
103
111guint64 *janus_uint64_dup(guint64 num);
112
117guint64 janus_uint64_hash(guint64 num);
118
124int janus_string_to_uint8(const char *str, uint8_t *num);
125
131int janus_string_to_uint16(const char *str, uint16_t *num);
132
138int janus_string_to_uint32(const char *str, uint32_t *num);
139
143
144typedef gsize janus_flags;
145
148void janus_flags_reset(janus_flags *flags);
149
153void janus_flags_set(janus_flags *flags, gsize flag);
154
158void janus_flags_clear(janus_flags *flags, gsize flag);
159
164gboolean janus_flags_is_set(janus_flags *flags, gsize flag);
166
172int janus_mkdir(const char *dir, mode_t mode);
173
179gchar *janus_make_absolute_path(const gchar *base_dir, const gchar *path);
180
185int janus_get_codec_pt(const char *sdp, const char *codec);
186
191const char *janus_get_codec_from_pt(const char *sdp, int pt);
192
196int janus_pidfile_create(const char *file);
197
200int janus_pidfile_remove(void);
201
205void janus_protected_folder_add(const char *folder);
206
210gboolean janus_is_folder_protected(const char *path);
211
214
220void janus_get_json_type_name(int jtype, unsigned int flags, char *type_name);
221
227gboolean janus_json_is_valid(json_t *val, json_type jtype, unsigned int flags);
228
239#define JANUS_VALIDATE_JSON_OBJECT_FORMAT(missing_format, invalid_format, obj, params, error_code, error_cause, log_error, missing_code, invalid_code) \
240 do { \
241 error_code = 0; \
242 unsigned int i; \
243 for(i = 0; i < sizeof(params) / sizeof(struct janus_json_parameter); i++) { \
244 json_t *val = json_object_get(obj, params[i].name); \
245 if(!val) { \
246 if((params[i].flags & JANUS_JSON_PARAM_REQUIRED) != 0) { \
247 error_code = (missing_code); \
248 if(log_error) \
249 JANUS_LOG(LOG_ERR, missing_format "\n", params[i].name); \
250 if(error_cause != NULL) \
251 g_snprintf(error_cause, sizeof(error_cause), missing_format, params[i].name); \
252 break; \
253 } \
254 continue; \
255 } \
256 if(!janus_json_is_valid(val, params[i].jtype, params[i].flags)) { \
257 error_code = (invalid_code); \
258 char type_name[20]; \
259 janus_get_json_type_name(params[i].jtype, params[i].flags, type_name); \
260 if(log_error) \
261 JANUS_LOG(LOG_ERR, invalid_format "\n", params[i].name, type_name); \
262 if(error_cause != NULL) \
263 g_snprintf(error_cause, sizeof(error_cause), invalid_format, params[i].name, type_name); \
264 break; \
265 } \
266 } \
267 } while(0)
268
277#define JANUS_VALIDATE_JSON_OBJECT(obj, params, error_code, error_cause, log_error, missing_code, invalid_code) \
278 JANUS_VALIDATE_JSON_OBJECT_FORMAT("Missing mandatory element (%s)", "Invalid element type (%s should be %s)", obj, params, error_code, error_cause, log_error, missing_code, invalid_code)
279
289#define JANUS_CHECK_SECRET(secret, obj, member, error_code, error_cause, missing_code, invalid_code, unauthorized_code) \
290 do { \
291 if (secret) { \
292 static struct janus_json_parameter secret_parameters[] = { \
293 {member, JSON_STRING, JANUS_JSON_PARAM_REQUIRED} \
294 }; \
295 JANUS_VALIDATE_JSON_OBJECT(obj, secret_parameters, error_code, error_cause, TRUE, missing_code, invalid_code); \
296 if(error_code == 0 && !janus_strcmp_const_time((secret), json_string_value(json_object_get(obj, member)))) { \
297 error_code = (unauthorized_code); \
298 JANUS_LOG(LOG_ERR, "Unauthorized (wrong %s)\n", member); \
299 if(error_cause != NULL) \
300 g_snprintf(error_cause, sizeof(error_cause), "Unauthorized (wrong %s)", member); \
301 } \
302 } \
303 } while(0)
304
309gboolean janus_vp8_is_keyframe(const char *buffer, int len);
310
315gboolean janus_vp9_is_keyframe(const char *buffer, int len);
316
321gboolean janus_h264_is_keyframe(const char *buffer, int len);
322
328gboolean janus_av1_is_keyframe(const char *buffer, int len);
329
335gboolean janus_h265_is_keyframe(const char *buffer, int len);
336
342
346
356int janus_vp8_parse_descriptor(char *buffer, int len,
357 uint16_t *picid, uint8_t *tl0picidx, uint8_t *tid, uint8_t *y, uint8_t *keyidx);
358
364void janus_vp8_simulcast_descriptor_update(char *buffer, int len, janus_vp8_simulcast_context *context, gboolean switched);
365
367typedef struct janus_vp9_svc_info {
369 uint8_t fbit, pbit, dbit, ubit, bbit, ebit;
371
378int janus_vp9_parse_svc(char *buffer, int len, gboolean *found, janus_vp9_svc_info *info);
379
385guint32 janus_push_bits(guint32 word, size_t num, guint32 val);
386
392void janus_set1(guint8 *data, size_t i, guint8 val);
393
399void janus_set2(guint8 *data, size_t i, guint32 val);
400
406void janus_set3(guint8 *data, size_t i, guint32 val);
407
413void janus_set4(guint8 *data, size_t i, guint32 val);
414
425size_t janus_gzip_compress(int compression, char *text, size_t tlen, char *compressed, size_t zlen);
426
427#endif
struct json_t json_t
Definition: plugin.h:236
Definition: utils.h:28
json_type jtype
Definition: utils.h:30
const gchar * name
Definition: utils.h:29
unsigned int flags
Definition: utils.h:31
VP8 simulcasting context, in order to make sure SSRC changes result in coherent picid/temporal level ...
Definition: utils.h:338
uint16_t last_picid
Definition: utils.h:339
uint8_t base_tlzi
Definition: utils.h:340
uint8_t last_tlzi
Definition: utils.h:340
uint8_t base_tlzi_prev
Definition: utils.h:340
uint16_t base_picid
Definition: utils.h:339
uint16_t base_picid_prev
Definition: utils.h:339
VP9 SVC info, as parsed from a payload descriptor.
Definition: utils.h:367
int temporal_layer
Definition: utils.h:368
uint8_t dbit
Definition: utils.h:369
uint8_t pbit
Definition: utils.h:369
uint8_t ebit
Definition: utils.h:369
int spatial_layer
Definition: utils.h:368
uint8_t bbit
Definition: utils.h:369
uint8_t fbit
Definition: utils.h:369
uint8_t ubit
Definition: utils.h:369
gboolean janus_av1_is_keyframe(const char *buffer, int len)
Helper method to check if an AV1 frame is a keyframe or not.
Definition: utils.c:855
guint64 janus_random_uint64(void)
Helper to generate random 52 bit unsigned integers.
Definition: utils.c:92
gsize janus_flags
Janus flags container.
Definition: utils.h:144
gboolean janus_vp8_is_keyframe(const char *buffer, int len)
Helper method to check if a VP8 frame is a keyframe or not.
Definition: utils.c:662
void janus_set4(guint8 *data, size_t i, guint32 val)
Helper method to set four bytes at a memory position.
Definition: utils.c:1181
gboolean janus_h264_is_keyframe(const char *buffer, int len)
Helper method to check if an H.264 frame is a keyframe or not.
Definition: utils.c:822
struct janus_vp8_simulcast_context janus_vp8_simulcast_context
VP8 simulcasting context, in order to make sure SSRC changes result in coherent picid/temporal level ...
size_t janus_gzip_compress(int compression, char *text, size_t tlen, char *compressed, size_t zlen)
Helper method to compress a string to gzip (using zlib)
Definition: utils.c:1189
guint32 janus_random_uint32(void)
Helper to generate random 32-bit unsigned integers (useful for SSRCs, etc.)
Definition: utils.c:74
char * janus_string_replace(char *message, const char *old_string, const char *new_string) G_GNUC_WARN_UNUSED_RESULT
Helper to replace strings.
Definition: utils.c:204
int janus_string_to_uint16(const char *str, uint16_t *num)
Helper method to convert a string to a uint16_t.
Definition: utils.c:158
gboolean janus_json_is_valid(json_t *val, json_type jtype, unsigned int flags)
Checks whether the JSON value matches the type and constraint.
Definition: utils.c:622
int janus_mkdir(const char *dir, mode_t mode)
Helper to create a new directory, and recursively create parent directories if needed.
Definition: utils.c:282
int janus_string_to_uint32(const char *str, uint32_t *num)
Helper method to convert a string to a uint32_t.
Definition: utils.c:168
void janus_set2(guint8 *data, size_t i, guint32 val)
Helper method to set two bytes at a memory position.
Definition: utils.c:1170
int janus_string_to_uint8(const char *str, uint8_t *num)
Helper method to convert a string to a uint8_t.
Definition: utils.c:148
void janus_vp8_simulcast_context_reset(janus_vp8_simulcast_context *context)
Set (or reset) the context fields to their default values.
Definition: utils.c:982
void janus_vp8_simulcast_descriptor_update(char *buffer, int len, janus_vp8_simulcast_context *context, gboolean switched)
Use the context info to update the RTP header of a packet, if needed.
Definition: utils.c:994
char * janus_random_uuid(void)
Helper to generate random UUIDs (needed by some plugins) Warning: this will fall back to a non-crypto...
Definition: utils.c:96
guint64 janus_uint64_hash(guint64 num)
Helper to hash a guint64 number to another guint64 number.
Definition: utils.c:141
struct janus_vp9_svc_info janus_vp9_svc_info
VP9 SVC info, as parsed from a payload descriptor.
gint64 janus_get_real_time(void)
Helper to retrieve the system real time, as Glib's g_get_real_time may not be available (only since 2...
Definition: utils.c:40
int janus_pidfile_remove(void)
Unlock and remove a previously created PID file.
Definition: utils.c:514
const char * janus_get_codec_from_pt(const char *sdp, int pt)
Ugly and dirty helper to quickly get the codec associated with a payload type in an SDP.
Definition: utils.c:416
void janus_set3(guint8 *data, size_t i, guint32 val)
Helper method to set three bytes at a memory position.
Definition: utils.c:1175
int janus_vp9_parse_svc(char *buffer, int len, gboolean *found, janus_vp9_svc_info *info)
Helper method to parse a VP9 payload descriptor for SVC-related info (e.g., when SVC is enabled)
Definition: utils.c:1019
gint64 janus_get_monotonic_time(void)
Helper to retrieve the system monotonic time, as Glib's g_get_monotonic_time may not be available (on...
Definition: utils.c:34
size_t janus_strlcat(char *dest, const char *src, size_t dest_size)
Helper method to concatenate strings and log an error if truncation occured.
Definition: utils.c:275
int janus_get_codec_pt(const char *sdp, const char *codec)
Ugly and dirty helper to quickly get the payload type associated with a codec in an SDP.
Definition: utils.c:319
void janus_protected_folder_add(const char *folder)
Add a folder to the protected list (meaning we won't create files there, like recordings or pcap dump...
Definition: utils.c:534
gboolean janus_is_true(const char *value)
Helper to parse yes/no|true/false configuration values.
Definition: utils.c:46
void janus_flags_reset(janus_flags *flags)
Janus flags reset method.
Definition: utils.c:178
guint64 * janus_uint64_dup(guint64 num)
Helper to generate an allocated copy of a guint64 number.
Definition: utils.c:135
guint32 janus_push_bits(guint32 word, size_t num, guint32 val)
Helper method to push individual bits at the end of a word.
Definition: utils.c:1160
int janus_vp8_parse_descriptor(char *buffer, int len, uint16_t *picid, uint8_t *tl0picidx, uint8_t *tid, uint8_t *y, uint8_t *keyidx)
Helper method to parse a VP8 payload descriptor for useful info (e.g., when simulcasting)
Definition: utils.c:881
void janus_get_json_type_name(int jtype, unsigned int flags, char *type_name)
Creates a string describing the JSON type and constraint.
Definition: utils.c:582
void janus_flags_clear(janus_flags *flags, gsize flag)
Janus flags clear method.
Definition: utils.c:189
gboolean janus_h265_is_keyframe(const char *buffer, int len)
Helper method to check if an H.265 frame is a keyframe or not.
Definition: utils.c:866
gboolean janus_vp9_is_keyframe(const char *buffer, int len)
Helper method to check if a VP9 frame is a keyframe or not.
Definition: utils.c:738
gboolean janus_is_folder_protected(const char *path)
Check if the path points to a protected folder.
Definition: utils.c:542
void janus_protected_folders_clear(void)
Cleanup the list of protected folder.
Definition: utils.c:575
void janus_flags_set(janus_flags *flags, gsize flag)
Janus flags set method.
Definition: utils.c:183
void janus_set1(guint8 *data, size_t i, guint8 val)
Helper method to set one byte at a memory position.
Definition: utils.c:1166
gboolean janus_flags_is_set(janus_flags *flags, gsize flag)
Janus flags check method.
Definition: utils.c:195
int janus_pidfile_create(const char *file)
Create and lock a PID file.
Definition: utils.c:475
gchar * janus_make_absolute_path(const gchar *base_dir, const gchar *path)
Helper to convert path relative to base_dir to absolute path. If path already represents absolute pat...
Definition: utils.c:309
gboolean janus_strcmp_const_time(const void *str1, const void *str2)
Helper to compare strings in constant time.
Definition: utils.c:50
guint64 janus_random_uint64_full(void)
Helper to generate random 64-bit unsigned integers.
Definition: utils.c:83