Fork me on GitHub
Macros | Functions
text2pcap.c File Reference

Dumping of RTP/RTCP packets to text2pcap format. More...

#include <errno.h>
#include <sys/time.h>
#include "text2pcap.h"
#include "debug.h"
#include "utils.h"
Include dependency graph for text2pcap.c:

Macros

#define CASE_STR(name)   case name: return #name
 

Functions

const char * janus_text2pcap_packet_string (janus_text2pcap_packet type)
 
janus_text2pcapjanus_text2pcap_create (const char *dir, const char *filename, int truncate)
 Create a text2pcap recorder. More...
 
int janus_text2pcap_dump (janus_text2pcap *instance, janus_text2pcap_packet type, gboolean incoming, char *buf, int len, const char *format,...)
 
int janus_text2pcap_close (janus_text2pcap *instance)
 Close a text2pcap recorder. More...
 
void janus_text2pcap_free (janus_text2pcap *instance)
 Free a text2pcap instance. More...
 

Detailed Description

Dumping of RTP/RTCP packets to text2pcap format.

Author
Lorenzo Miniero loren.nosp@m.zo@m.nosp@m.eetec.nosp@m.ho.c.nosp@m.om

Implementation of a simple helper utility that can be used to dump incoming and outgoing RTP/RTCP packets to text2pcap format. The resulting file can then be passed to the text2pcap application in order to get a .pcap or .pcapng file that can be analyzed via Wireshark or similar applications, e.g.:

/usr/sbin/text2pcap -D -n -l 1 -i 17 -u 1000,2000 -t '%H:%M:%S.' dump.txt dump.pcapng
/usr/sbin/wireshark dump.pcapng

While plugins are free to take advantage of this functionality, it's been specifically added to make debugging from the core easier. Enabling and disabling the dump of RTP/RTCP packets for the media traffic of a specific handle is done via the Admin/Monitor API so check the documentation of that section for more details. Notice that starting a new dump on an existing filename will result in the new packets to be appended.

Note
Motivation and inspiration for this work came from a similar effort recently done in Firefox, and from a discussion related to a blog post on WebRTC hacks, where guidelines are provided with respect to debugging based on pcap files.

Core

Macro Definition Documentation

#define CASE_STR (   name)    case name: return #name

Function Documentation

int janus_text2pcap_close ( janus_text2pcap instance)

Close a text2pcap recorder.

Parameters
[in]instanceInstance of the janus_text2pcap recorder to close
Returns
0 in case of success, a negative integer otherwise
janus_text2pcap* janus_text2pcap_create ( const char *  dir,
const char *  filename,
int  truncate 
)

Create a text2pcap recorder.

Note
If no target directory is provided, the current directory will be used. If no filename is passed, a random filename will be used.
Parameters
[in]dirPath of the directory to save the recording into (will try to create it if it doesn't exist)
[in]filenameFilename to use for the recording
[in]truncateNumber of bytes to truncate each packet at (0 to not truncate at all)
Returns
A valid janus_text2pcap instance in case of success, NULL otherwise
int janus_text2pcap_dump ( janus_text2pcap instance,
janus_text2pcap_packet  type,
gboolean  incoming,
char *  buf,
int  len,
const char *  format,
  ... 
)
void janus_text2pcap_free ( janus_text2pcap instance)

Free a text2pcap instance.

Parameters
[in]instanceInstance of the janus_text2pcap recorder to free
const char* janus_text2pcap_packet_string ( janus_text2pcap_packet  type)