Fork me on GitHub
Data Structures | Typedefs | Enumerations | Functions
text2pcap.h File Reference

Dumping of RTP/RTCP packets to text2pcap format (headers) More...

#include <glib.h>
#include <inttypes.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include "mutex.h"
Include dependency graph for text2pcap.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  janus_text2pcap
 Instance of a text2pcap recorder. More...
 

Typedefs

typedef struct janus_text2pcap janus_text2pcap
 Instance of a text2pcap recorder. More...
 
typedef enum janus_text2pcap_packet janus_text2pcap_packet
 Packet types we can dump. More...
 

Enumerations

enum  janus_text2pcap_packet { JANUS_TEXT2PCAP_RTP, JANUS_TEXT2PCAP_RTCP, JANUS_TEXT2PCAP_DATA }
 Packet types we can dump. More...
 

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,...) G_GNUC_PRINTF(6
 Dump an RTP or RTCP packet. More...
 
int 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 (headers)

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

Typedef Documentation

Instance of a text2pcap recorder.

Packet types we can dump.

Enumeration Type Documentation

Packet types we can dump.

Enumerator
JANUS_TEXT2PCAP_RTP 
JANUS_TEXT2PCAP_RTCP 
JANUS_TEXT2PCAP_DATA 

Function Documentation

int 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,
  ... 
)

Dump an RTP or RTCP packet.

Parameters
[in]instanceInstance of the janus_text2pcap recorder to dump the packet to
[in]typeType of the packet we're going to dump
[in]incomingWhether this is an incoming or outgoing packet
[in]bufPacket data to dump
[in]lenSize of the packet data to dump
[in]formatFormat for the optional string to append to the line, if any
Returns
0 in case of success, a negative integer otherwise
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)