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 
37 gint64 janus_get_monotonic_time(void);
38 
42 gint64 janus_get_real_time(void);
43 
50 char *janus_string_replace(char *message, const char *old_string, const char *new_string) G_GNUC_WARN_UNUSED_RESULT;
51 
57 size_t janus_strlcat(char *dest, const char *src, size_t dest_size);
58 
67 int janus_strlcat_fast(char *dest, const char *src, size_t dest_size, size_t *offset);
68 
72 gboolean janus_is_true(const char *value);
73 
78 gboolean janus_strcmp_const_time(const void *str1, const void *str2);
79 
84 guint32 janus_random_uint32(void);
85 
92 guint64 janus_random_uint64_full(void);
93 
106 guint64 janus_random_uint64(void);
107 
112 char *janus_random_uuid(void);
113 
121 guint64 *janus_uint64_dup(guint64 num);
122 
127 guint64 janus_uint64_hash(guint64 num);
128 
134 int janus_string_to_uint8(const char *str, uint8_t *num);
135 
141 int janus_string_to_uint16(const char *str, uint16_t *num);
142 
148 int janus_string_to_uint32(const char *str, uint32_t *num);
149 
153 
154 typedef gsize janus_flags;
155 
158 void janus_flags_reset(janus_flags *flags);
159 
163 void janus_flags_set(janus_flags *flags, gsize flag);
164 
168 void janus_flags_clear(janus_flags *flags, gsize flag);
169 
174 gboolean janus_flags_is_set(janus_flags *flags, gsize flag);
176 
182 int janus_mkdir(const char *dir, mode_t mode);
183 
189 gchar *janus_make_absolute_path(const gchar *base_dir, const gchar *path);
190 
195 int janus_get_codec_pt(const char *sdp, const char *codec);
196 
201 const char *janus_get_codec_from_pt(const char *sdp, int pt);
202 
206 int janus_pidfile_create(const char *file);
207 
210 int janus_pidfile_remove(void);
211 
215 void janus_protected_folder_add(const char *folder);
216 
220 gboolean janus_is_folder_protected(const char *path);
221 
224 
230 void janus_get_json_type_name(int jtype, unsigned int flags, char *type_name);
231 
237 gboolean janus_json_is_valid(json_t *val, json_type jtype, unsigned int flags);
238 
249 #define JANUS_VALIDATE_JSON_OBJECT_FORMAT(missing_format, invalid_format, obj, params, error_code, error_cause, log_error, missing_code, invalid_code) \
250  do { \
251  error_code = 0; \
252  unsigned int i; \
253  for(i = 0; i < sizeof(params) / sizeof(struct janus_json_parameter); i++) { \
254  json_t *val = json_object_get(obj, params[i].name); \
255  if(!val) { \
256  if((params[i].flags & JANUS_JSON_PARAM_REQUIRED) != 0) { \
257  error_code = (missing_code); \
258  if(log_error) \
259  JANUS_LOG(LOG_ERR, missing_format "\n", params[i].name); \
260  if(error_cause != NULL) \
261  g_snprintf(error_cause, sizeof(error_cause), missing_format, params[i].name); \
262  break; \
263  } \
264  continue; \
265  } \
266  if(!janus_json_is_valid(val, params[i].jtype, params[i].flags)) { \
267  error_code = (invalid_code); \
268  char type_name[20]; \
269  janus_get_json_type_name(params[i].jtype, params[i].flags, type_name); \
270  if(log_error) \
271  JANUS_LOG(LOG_ERR, invalid_format "\n", params[i].name, type_name); \
272  if(error_cause != NULL) \
273  g_snprintf(error_cause, sizeof(error_cause), invalid_format, params[i].name, type_name); \
274  break; \
275  } \
276  } \
277  } while(0)
278 
287 #define JANUS_VALIDATE_JSON_OBJECT(obj, params, error_code, error_cause, log_error, missing_code, invalid_code) \
288  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)
289 
299 #define JANUS_CHECK_SECRET(secret, obj, member, error_code, error_cause, missing_code, invalid_code, unauthorized_code) \
300  do { \
301  if (secret) { \
302  static struct janus_json_parameter secret_parameters[] = { \
303  {member, JSON_STRING, JANUS_JSON_PARAM_REQUIRED} \
304  }; \
305  JANUS_VALIDATE_JSON_OBJECT(obj, secret_parameters, error_code, error_cause, TRUE, missing_code, invalid_code); \
306  if(error_code == 0 && !janus_strcmp_const_time((secret), json_string_value(json_object_get(obj, member)))) { \
307  error_code = (unauthorized_code); \
308  JANUS_LOG(LOG_ERR, "Unauthorized (wrong %s)\n", member); \
309  if(error_cause != NULL) \
310  g_snprintf(error_cause, sizeof(error_cause), "Unauthorized (wrong %s)", member); \
311  } \
312  } \
313  } while(0)
314 
319 gboolean janus_vp8_is_keyframe(const char *buffer, int len);
320 
325 gboolean janus_vp9_is_keyframe(const char *buffer, int len);
326 
331 gboolean janus_h264_is_keyframe(const char *buffer, int len);
332 
338 gboolean janus_av1_is_keyframe(const char *buffer, int len);
339 
345 gboolean janus_h265_is_keyframe(const char *buffer, int len);
346 
352 
356 
366 int janus_vp8_parse_descriptor(char *buffer, int len,
367  uint16_t *picid, uint8_t *tl0picidx, uint8_t *tid, uint8_t *y, uint8_t *keyidx);
368 
374 void janus_vp8_simulcast_descriptor_update(char *buffer, int len, janus_vp8_simulcast_context *context, gboolean switched);
375 
377 typedef struct janus_vp9_svc_info {
379  uint8_t fbit, pbit, dbit, ubit, bbit, ebit;
381 
388 int janus_vp9_parse_svc(char *buffer, int len, gboolean *found, janus_vp9_svc_info *info);
389 
391 typedef struct janus_red_block {
392  uint8_t pt;
393  uint32_t ts_offset;
394  uint8_t *data;
395  uint16_t length;
402 GList *janus_red_parse_blocks(char *buffer, int len);
408 int janus_red_pack_blocks(char *buffer, int len, GList *blocks);
414 int janus_red_replace_block_pt(char *buffer, int len, int pt);
415 
421 guint32 janus_push_bits(guint32 word, size_t num, guint32 val);
422 
428 void janus_set1(guint8 *data, size_t i, guint8 val);
429 
435 void janus_set2(guint8 *data, size_t i, guint32 val);
436 
442 void janus_set3(guint8 *data, size_t i, guint32 val);
443 
449 void janus_set4(guint8 *data, size_t i, guint32 val);
450 
451 /* \brief Helpers to read a bit from a bitstream
452  * @param[in] base Pointer to the start of the bitstream
453  * @param[in] offset Offset in bits from the start
454  * @returns The value of the bit */
455 uint8_t janus_bitstream_getbit(uint8_t *base, uint32_t offset);
456 /* \brief Helpers to read agroup of bits from a bitstream
457  * @param[in] base Pointer to the start of the bitstream
458  * @param[in] num The number of bits to read
459  * @param[in] offset Offset in bits from the start
460  * @returns The value of the bits */
461 uint32_t janus_bitstream_getbits(uint8_t *base, uint8_t num, uint32_t *offset);
462 
473 size_t janus_gzip_compress(int compression, char *text, size_t tlen, char *compressed, size_t zlen);
474 
475 #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
Helper struct to address a specific RED block.
Definition: utils.h:391
uint16_t length
Definition: utils.h:395
uint8_t * data
Definition: utils.h:394
uint8_t pt
Definition: utils.h:392
uint32_t ts_offset
Definition: utils.h:393
VP8 simulcasting context, in order to make sure SSRC changes result in coherent picid/temporal level ...
Definition: utils.h:348
uint16_t last_picid
Definition: utils.h:349
uint8_t base_tlzi
Definition: utils.h:350
uint8_t last_tlzi
Definition: utils.h:350
uint8_t base_tlzi_prev
Definition: utils.h:350
uint16_t base_picid
Definition: utils.h:349
uint16_t base_picid_prev
Definition: utils.h:349
VP9 SVC info, as parsed from a payload descriptor.
Definition: utils.h:377
int temporal_layer
Definition: utils.h:378
uint8_t dbit
Definition: utils.h:379
uint8_t pbit
Definition: utils.h:379
uint8_t ebit
Definition: utils.h:379
int spatial_layer
Definition: utils.h:378
uint8_t bbit
Definition: utils.h:379
uint8_t fbit
Definition: utils.h:379
uint8_t ubit
Definition: utils.h:379
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:879
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:154
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:686
void janus_set4(guint8 *data, size_t i, guint32 val)
Helper method to set four bytes at a memory position.
Definition: utils.c:1360
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:846
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:1381
guint32 janus_random_uint32(void)
Helper to generate random 32-bit unsigned integers (useful for SSRCs, etc.)
Definition: utils.c:74
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:1186
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:646
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:303
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:1349
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:1007
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:1019
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:538
void janus_set3(guint8 *data, size_t i, guint32 val)
Helper method to set three bytes at a memory position.
Definition: utils.c:1354
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:330
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:1044
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:340
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:558
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
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:1339
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:438
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:906
int janus_red_pack_blocks(char *buffer, int len, GList *blocks)
Helper method to pack multiple buffers in a RED payload.
Definition: utils.c:1268
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:606
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:890
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:762
gboolean janus_is_folder_protected(const char *path)
Check if the path points to a protected folder.
Definition: utils.c:566
void janus_protected_folders_clear(void)
Cleanup the list of protected folder.
Definition: utils.c:599
uint32_t janus_bitstream_getbits(uint8_t *base, uint8_t num, uint32_t *offset)
Definition: utils.c:1371
struct janus_red_block janus_red_block
Helper struct to address a specific RED block.
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:1345
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:499
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
gboolean janus_strcmp_const_time(const void *str1, const void *str2)
Helper to compare strings in constant time.
Definition: utils.c:50
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 occured,...
Definition: utils.c:282
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_random_uint64_full(void)
Helper to generate random 64-bit unsigned integers.
Definition: utils.c:83
guint64 * janus_uint64_dup(guint64 num)
Helper to generate an allocated copy of a guint64 number.
Definition: utils.c:135
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:1314
uint8_t janus_bitstream_getbit(uint8_t *base, uint32_t offset)
Definition: utils.c:1367