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 #define JANUS_JSON_ARRAY JSON_ARRAY
23 /* Use JANUS_JSON_BOOL instead of the non-existing JSON_BOOLEAN */
24 #define JANUS_JSON_BOOL JSON_TRUE
25 #define JANUS_JSON_PARAM_REQUIRED 1
26 #define JANUS_JSON_PARAM_POSITIVE 2
27 #define JANUS_JSON_PARAM_NONEMPTY 4
28 
30  const gchar *name;
31  json_type jtype;
32  unsigned int flags;
33 };
34 
35 #ifndef htonll
36 #define htonll(x) ((1==htonl(1)) ? (x) : ((guint64)htonl((x) & 0xFFFFFFFF) << 32) | htonl((x) >> 32))
37 #endif
38 #ifndef ntohll
39 #define ntohll(x) ((1==ntohl(1)) ? (x) : ((guint64)ntohl((x) & 0xFFFFFFFF) << 32) | ntohl((x) >> 32))
40 #endif
41 
42 
44 void janus_mark_started(void);
45 
50 
55 gint64 janus_get_monotonic_time(void);
56 
60 gint64 janus_get_real_time(void);
61 
68 char *janus_string_replace(char *message, const char *old_string, const char *new_string) G_GNUC_WARN_UNUSED_RESULT;
69 
75 size_t janus_strlcat(char *dest, const char *src, size_t dest_size);
76 
85 int janus_strlcat_fast(char *dest, const char *src, size_t dest_size, size_t *offset);
86 
90 gboolean janus_is_true(const char *value);
91 
96 gboolean janus_strcmp_const_time(const void *str1, const void *str2);
97 
102 guint32 janus_random_uint32(void);
103 
110 guint64 janus_random_uint64_full(void);
111 
124 guint64 janus_random_uint64(void);
125 
130 char *janus_random_uuid(void);
131 
139 guint64 *janus_uint64_dup(guint64 num);
140 
145 guint64 janus_uint64_hash(guint64 num);
146 
152 int janus_string_to_uint8(const char *str, uint8_t *num);
153 
159 int janus_string_to_uint16(const char *str, uint16_t *num);
160 
166 int janus_string_to_uint32(const char *str, uint32_t *num);
167 
170 
172 typedef gsize janus_flags;
173 
176 void janus_flags_reset(janus_flags *flags);
177 
181 void janus_flags_set(janus_flags *flags, gsize flag);
182 
186 void janus_flags_clear(janus_flags *flags, gsize flag);
187 
192 gboolean janus_flags_is_set(janus_flags *flags, gsize flag);
194 
200 int janus_mkdir(const char *dir, mode_t mode);
201 
207 gchar *janus_make_absolute_path(const gchar *base_dir, const gchar *path);
208 
213 int janus_get_codec_pt(const char *sdp, const char *codec);
214 
219 const char *janus_get_codec_from_pt(const char *sdp, int pt);
220 
224 int janus_pidfile_create(const char *file);
225 
228 int janus_pidfile_remove(void);
229 
233 void janus_protected_folder_add(const char *folder);
234 
238 gboolean janus_is_folder_protected(const char *path);
239 
242 
247 void janus_get_json_type_name(int jtype, unsigned int flags, char *type_name);
248 
254 gboolean janus_json_is_valid(json_t *val, json_type jtype, unsigned int flags);
255 
266 #define JANUS_VALIDATE_JSON_OBJECT_FORMAT(missing_format, invalid_format, obj, params, error_code, error_cause, log_error, missing_code, invalid_code) \
267  do { \
268  error_code = 0; \
269  unsigned int i; \
270  for(i = 0; i < sizeof(params) / sizeof(struct janus_json_parameter); i++) { \
271  json_t *val = json_object_get(obj, params[i].name); \
272  if(!val) { \
273  if((params[i].flags & JANUS_JSON_PARAM_REQUIRED) != 0) { \
274  error_code = (missing_code); \
275  if(log_error) \
276  JANUS_LOG(LOG_ERR, missing_format "\n", params[i].name); \
277  if(error_cause != NULL) \
278  g_snprintf(error_cause, sizeof(error_cause), missing_format, params[i].name); \
279  break; \
280  } \
281  continue; \
282  } \
283  if(!janus_json_is_valid(val, params[i].jtype, params[i].flags)) { \
284  error_code = (invalid_code); \
285  char type_name[20]; \
286  janus_get_json_type_name(params[i].jtype, params[i].flags, type_name); \
287  if(log_error) \
288  JANUS_LOG(LOG_ERR, invalid_format "\n", params[i].name, type_name); \
289  if(error_cause != NULL) \
290  g_snprintf(error_cause, sizeof(error_cause), invalid_format, params[i].name, type_name); \
291  break; \
292  } \
293  } \
294  } while(0)
295 
304 #define JANUS_VALIDATE_JSON_OBJECT(obj, params, error_code, error_cause, log_error, missing_code, invalid_code) \
305  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)
306 
316 #define JANUS_CHECK_SECRET(secret, obj, member, error_code, error_cause, missing_code, invalid_code, unauthorized_code) \
317  do { \
318  if (secret) { \
319  static struct janus_json_parameter secret_parameters[] = { \
320  {member, JSON_STRING, JANUS_JSON_PARAM_REQUIRED} \
321  }; \
322  JANUS_VALIDATE_JSON_OBJECT(obj, secret_parameters, error_code, error_cause, TRUE, missing_code, invalid_code); \
323  if(error_code == 0 && !janus_strcmp_const_time((secret), json_string_value(json_object_get(obj, member)))) { \
324  error_code = (unauthorized_code); \
325  JANUS_LOG(LOG_ERR, "Unauthorized (wrong %s)\n", member); \
326  if(error_cause != NULL) \
327  g_snprintf(error_cause, sizeof(error_cause), "Unauthorized (wrong %s)", member); \
328  } \
329  } \
330  } while(0)
331 
336 gboolean janus_vp8_is_keyframe(const char *buffer, int len);
337 
342 gboolean janus_vp9_is_keyframe(const char *buffer, int len);
343 
352 gboolean janus_h264_is_keyframe(const char *buffer, int len);
353 
358 gboolean janus_h264_is_i_frame(const char *buffer, int len);
359 
364 gboolean janus_h264_is_b_frame(const char *buffer, int len);
365 
370 gboolean janus_av1_is_keyframe(const char *buffer, int len);
371 
376 gboolean janus_h265_is_keyframe(const char *buffer, int len);
377 
384 gboolean janus_is_keyframe(int codec, const char *buffer, int len);
385 
391 
395 
406 int janus_vp8_parse_descriptor(char *buffer, int len,
407  gboolean *m, uint16_t *picid, uint8_t *tl0picidx, uint8_t *tid, uint8_t *y, uint8_t *keyidx);
408 
414 void janus_vp8_simulcast_descriptor_update(char *buffer, int len, janus_vp8_simulcast_context *context, gboolean switched);
415 
417 typedef struct janus_vp9_svc_info {
419  uint8_t fbit, pbit, dbit, ubit, bbit, ebit;
421 
428 int janus_vp9_parse_svc(char *buffer, int len, gboolean *found, janus_vp9_svc_info *info);
429 
431 typedef struct janus_red_block {
432  uint8_t pt;
433  uint32_t ts_offset;
434  uint8_t *data;
435  uint16_t length;
442 GList *janus_red_parse_blocks(char *buffer, int len);
448 int janus_red_pack_blocks(char *buffer, int len, GList *blocks);
454 int janus_red_replace_block_pt(char *buffer, int len, int pt);
455 
461 guint32 janus_push_bits(guint32 word, size_t num, guint32 val);
462 
468 void janus_set1(guint8 *data, size_t i, guint8 val);
469 
475 void janus_set2(guint8 *data, size_t i, guint32 val);
476 
482 void janus_set3(guint8 *data, size_t i, guint32 val);
483 
489 void janus_set4(guint8 *data, size_t i, guint32 val);
490 
495 uint8_t janus_bitstream_getbit(uint8_t *base, uint32_t offset);
501 uint32_t janus_bitstream_getbits(uint8_t *base, uint8_t num, uint32_t *offset);
502 
513 size_t janus_gzip_compress(int compression, char *text, size_t tlen, char *compressed, size_t zlen);
514 
515 #endif
uint8_t base_tlzi_prev
Definition: utils.h:389
unsigned int flags
Definition: utils.h:32
void janus_set2(guint8 *data, size_t i, guint32 val)
Helper method to set two bytes at a memory position.
Definition: utils.c:1408
gsize janus_flags
Janus flags container.
Definition: utils.h:172
int janus_string_to_uint32(const char *str, uint32_t *num)
Helper method to convert a string to a uint32_t.
Definition: utils.c:179
struct json_t json_t
Definition: plugin.h:236
guint64 janus_random_uint64_full(void)
Helper to generate random 64-bit unsigned integers.
Definition: utils.c:94
Helper struct to address a specific RED block.
Definition: utils.h:431
int janus_red_pack_blocks(char *buffer, int len, GList *blocks)
Helper method to pack multiple buffers in a RED payload.
Definition: utils.c:1327
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:349
guint64 janus_random_uint64(void)
Helper to generate random 52 bit unsigned integers.
Definition: utils.c:103
uint8_t dbit
Definition: utils.h:419
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:455
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:923
int janus_red_replace_block_pt(char *buffer, int len, int pt)
Helper method to overwrite all RTP payload types in RED blocks.
Definition: utils.c:1373
int janus_pidfile_create(const char *file)
Create and lock a PID file.
Definition: utils.c:520
guint64 janus_uint64_hash(guint64 num)
Helper to hash a guint64 number to another guint64 number.
Definition: utils.c:152
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:627
gint64 janus_get_monotonic_time_internal(void)
Helper to retrieve the system monotonic time, as Glib&#39;s g_get_monotonic_time may not be available (on...
Definition: utils.c:35
uint32_t ts_offset
Definition: utils.h:433
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:1105
int janus_string_to_uint16(const char *str, uint16_t *num)
Helper method to convert a string to a uint16_t.
Definition: utils.c:169
uint8_t fbit
Definition: utils.h:419
void janus_vp8_simulcast_context_reset(janus_vp8_simulcast_context *context)
Set (or reset) the context fields to their default values.
Definition: utils.c:1060
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:312
int janus_strlcat_fast(char *dest, const char *src, size_t dest_size, size_t *offset)
Alternative helper method to concatenate strings and log an error if truncation occurred, which uses memccpy instead of g_strlcat and so is supposed to be faster.
Definition: utils.c:291
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:339
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:783
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:707
uint16_t base_picid_prev
Definition: utils.h:388
void janus_flags_reset(janus_flags *flags)
Janus flags reset method.
Definition: utils.c:189
gboolean janus_h264_is_b_frame(const char *buffer, int len)
Helper method to check if an H.264 frame contains a B-Frame or not.
Definition: utils.c:908
VP9 SVC info, as parsed from a payload descriptor.
Definition: utils.h:417
int janus_vp8_parse_descriptor(char *buffer, int len, gboolean *m, 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:957
void janus_set4(guint8 *data, size_t i, guint32 val)
Helper method to set four bytes at a memory position.
Definition: utils.c:1419
VP8 simulcasting context, in order to make sure SSRC changes result in coherent picid/temporal level ...
Definition: utils.h:387
void janus_protected_folders_clear(void)
Cleanup the list of protected folder.
Definition: utils.c:620
const gchar * name
Definition: utils.h:30
gint64 janus_get_monotonic_time(void)
Helper to retrieve the system monotonic time, as Glib&#39;s g_get_monotonic_time may not be available (on...
Definition: utils.c:47
json_type jtype
Definition: utils.h:31
uint8_t bbit
Definition: utils.h:419
uint16_t length
Definition: utils.h:435
uint8_t pt
Definition: utils.h:432
uint8_t ubit
Definition: utils.h:419
int janus_string_to_uint8(const char *str, uint8_t *num)
Helper method to convert a string to a uint8_t.
Definition: utils.c:159
gint64 janus_get_real_time(void)
Helper to retrieve the system real time, as Glib&#39;s g_get_real_time may not be available (only since 2...
Definition: utils.c:51
uint8_t last_tlzi
Definition: utils.h:389
uint8_t * data
Definition: utils.h:434
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 ...
int temporal_layer
Definition: utils.h:418
gboolean janus_h264_is_i_frame(const char *buffer, int len)
Helper method to check if an H.264 frame contains an I-Frame or not.
Definition: utils.c:904
Definition: utils.h:29
void janus_set3(guint8 *data, size_t i, guint32 val)
Helper method to set three bytes at a memory position.
Definition: utils.c:1413
guint32 janus_random_uint32(void)
Helper to generate random 32-bit unsigned integers (useful for SSRCs, etc.)
Definition: utils.c:85
uint16_t base_picid
Definition: utils.h:388
gboolean janus_flags_is_set(janus_flags *flags, gsize flag)
Janus flags check method.
Definition: utils.c:206
gboolean janus_is_keyframe(int codec, const char *buffer, int len)
Helper method to check if keyframe or not, using one of the codec specific helper methods according t...
Definition: utils.c:939
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:1398
GList * janus_red_parse_blocks(char *buffer, int len)
Helper method to parse an RTP payload to return a list of RED blocks.
Definition: utils.c:1247
void janus_protected_folder_add(const char *folder)
Add a folder to the protected list (meaning we won&#39;t create files there, like recordings or pcap dump...
Definition: utils.c:579
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:900
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:215
gboolean janus_is_folder_protected(const char *path)
Check if the path points to a protected folder.
Definition: utils.c:587
int janus_pidfile_remove(void)
Unlock and remove a previously created PID file.
Definition: utils.c:559
void janus_flags_set(janus_flags *flags, gsize flag)
Janus flags set method.
Definition: utils.c:194
guint64 * janus_uint64_dup(guint64 num)
Helper to generate an allocated copy of a guint64 number.
Definition: utils.c:146
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:912
int spatial_layer
Definition: utils.h:418
size_t janus_strlcat(char *dest, const char *src, size_t dest_size)
Helper method to concatenate strings and log an error if truncation occurred.
Definition: utils.c:284
struct janus_vp9_svc_info janus_vp9_svc_info
VP9 SVC info, as parsed from a payload descriptor.
gboolean janus_is_true(const char *value)
Helper to parse yes/no|true/false configuration values.
Definition: utils.c:57
uint16_t last_picid
Definition: utils.h:388
void janus_flags_clear(janus_flags *flags, gsize flag)
Janus flags clear method.
Definition: utils.c:200
uint8_t janus_bitstream_getbit(uint8_t *base, uint32_t offset)
Helpers to read a bit from a bitstream.
Definition: utils.c:1426
uint8_t base_tlzi
Definition: utils.h:389
gboolean janus_strcmp_const_time(const void *str1, const void *str2)
Helper to compare strings in constant time.
Definition: utils.c:61
uint32_t janus_bitstream_getbits(uint8_t *base, uint8_t num, uint32_t *offset)
Helpers to read agroup of bits from a bitstream.
Definition: utils.c:1430
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:107
struct janus_red_block janus_red_block
Helper struct to address a specific RED block.
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:1072
uint8_t pbit
Definition: utils.h:419
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:1440
void janus_mark_started(void)
Definition: utils.c:42
void janus_set1(guint8 *data, size_t i, guint8 val)
Helper method to set one byte at a memory position.
Definition: utils.c:1404
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:667
uint8_t ebit
Definition: utils.h:419