wiretap 0.1 → 0.1.2

data/ext/node.cpp

@@ -30,12 +30,18 @@ static VALUE node_detect_klass(WireTapNodeHandle* node) {
 		case IFFFS_WT_TYPE_REEL: {
 			return cReel;
 		}
-		case IFFFS_WT_TYPE_CLIP:
-		case IFFFS_WT_TYPE_CLIP_HIRES:
-		case IFFFS_WT_TYPE_CLIP_LOWRES:
-		case IFFFS_WT_TYPE_CLIP_SLATE: {
-			return cClip;
-		}
+    case IFFFS_WT_TYPE_CLIP: {
+      return cClip;
+    }
+    case IFFFS_WT_TYPE_CLIP_HIRES: {
+      return cHiresClip;
+    }
+    case IFFFS_WT_TYPE_CLIP_LOWRES: {
+      return cLowresClip;
+    }
+    case IFFFS_WT_TYPE_CLIP_SLATE: {
+    	return cSlateClip;
+    }
 		case IFFFS_WT_TYPE_CLIP_AUDIO:
 		case IFFFS_WT_TYPE_CLIP_AUDIO_STREAM: {
 			return cAudio;
@@ -63,6 +69,7 @@ static VALUE wiretap_node_allocate(VALUE klass) {
 	return Data_Wrap_Struct(klass, 0, node_free, new_node);
 }
 
+/* Returns the node ID of the given node - a unique path to the node on the particular Wiretap host */
 static VALUE wiretap_node_get_id(VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -71,16 +78,18 @@ static VALUE wiretap_node_get_id(VALUE self) {
 	return rb_str_new2(node->getNodeId().id());
 }
 
+/* Sets the node ID, use with caution */
 static VALUE wiretap_node_set_id(VALUE self, VALUE id) {
 	Check_Node_Alive(self);
 	
 	WireTapNodeHandle* node;
 	Check_Type(id, T_STRING);
 	Data_Get_Struct(self, WireTapNodeHandle, node);
-//	node->setNodeId(WireTapNodeId(STR(id)));
+  node->setNodeId(WireTapNodeId(STR(id)));
 	return self;
 }
 
+/* Reload the node information from the server */
 static VALUE wiretap_node_reload(VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -93,6 +102,7 @@ static VALUE wiretap_node_reload(VALUE self) {
 	return self;
 }
 
+/* Find a Wiretap node in the children of the current node */
 static VALUE wiretap_node_find(VALUE self, VALUE path) {
 	Check_Node_Alive(self);
 	
@@ -114,7 +124,7 @@ static VALUE wiretap_node_find(VALUE self, VALUE path) {
 	return wiretap_node_create_with(child, rb_iv_get(self, "@server"), self);
 }
 
-
+/* Import a directory of PPM files into the clip */
 static VALUE wiretap_clip_import_directory(VALUE self, VALUE dir_name) {
 	Check_Node_Alive(self);
 	
@@ -142,41 +152,30 @@ static VALUE wiretap_clip_import_directory(VALUE self, VALUE dir_name) {
 	}
 	
 
-	NODERUN_E(node, node->setNumFrames(count));
+	NODERUN_EX_E(node, node->setNumFrames(count));
 	WireTapClipFormat format;
 	NODERUN_E(node, node->getClipFormat(format));	
-	unsigned char frame[format.frameBufferSize()];
-
-  /** TODO - refactor to use write_frame **/
 
 	for(int i = 0; i < count; i++) {
 		char filename[PATH_MAX];
 		snprintf(filename, sizeof(filename), "%s/%08d.ppm", STR(dir_name), i+1);
 		//rb_warn("Opening file %s", filename);
 
-
-		FILE* infile = fopen(filename, "r");
-		if(!infile) {
-			THROW("Couldn't open file %s for read", filename);
-		}
-		
-		if(!ppm_read_format(infile, NULL)) {
-			fclose(infile);
-			THROW("Couldn't read PPM format from file %s", filename);
+		std::auto_ptr<ImageIO> image(ImageIO::open(filename, format));
+		if(!image.get()) {
+			image.release();
+			THROW("Couldn't open file %s for reading", filename);
 		}
-
-		if(!ppm_read_image(infile, frame, format.width(), format.height(), format.bitsPerPixel())) {
-			fclose(infile);
-			rb_warn("Couldn't read PPM image data from file %s", filename);
-			return Qnil;
-		}
-		fclose(infile);
-		
-		NODERUN_E(node, node->writeFrame(i, frame, sizeof(frame)));
+		image->read_format();
+		std::auto_ptr<unsigned char> frame(image->read_data());
+		NODERUN_EX_E(node, node->writeFrame(i, frame.get(), format.frameBufferSize()));
 	}
 	return self;
 }
 
+/* 
+* Get extended type of the particular node as string
+*/
 static VALUE wiretap_node_get_type(VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -187,6 +186,9 @@ static VALUE wiretap_node_get_type(VALUE self) {
 	return wiretap_to_str(type);
 }
 
+/* 
+* Get name of the particular node
+*/
 static VALUE wiretap_node_get_name(VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -198,6 +200,7 @@ static VALUE wiretap_node_get_name(VALUE self) {
 }
 
 
+/* Provided a name and a type creates a child node */
 static VALUE wiretap_node_create_node(int argc, VALUE* argv, VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -214,10 +217,10 @@ static VALUE wiretap_node_create_node(int argc, VALUE* argv, VALUE self) {
 	}
 	switch(TYPE(extended_type)) {
 		case T_FIXNUM:
-			NODERUN_E(node, node->createNode(CSTR(display_name), NUM2INT(extended_type), node_return));
+			NODERUN_EX_E(node, node->createNode(CSTR(display_name), NUM2INT(extended_type), node_return));
 			break;
 		case T_STRING:
-			NODERUN_E(node, node->createNode(CSTR(display_name), CSTR(extended_type), node_return));
+			NODERUN_EX_E(node, node->createNode(CSTR(display_name), CSTR(extended_type), node_return));
 			break;
 		default:
 			rb_raise(rb_eArgError, "extended type must be integer or string");
@@ -239,7 +242,7 @@ static VALUE wiretap_node_create_clip(int argc, VALUE* argv, VALUE self) {
 	WireTapNodeHandle node_return;
 
 	if(extended_type == Qnil) {
-		extended_type = INT2FIX(0);
+		extended_type = INT2FIX(IFFFS_WT_TYPE_CLIP);
 	}
 	if(format == Qnil) {
 		format = rb_funcall(self, rb_intern("format"), 0);
@@ -250,23 +253,28 @@ static VALUE wiretap_node_create_clip(int argc, VALUE* argv, VALUE self) {
 	
 	switch(TYPE(extended_type)) {
 		case T_FIXNUM:
-			NODERUN_E(node, node->createClipNode(CSTR(display_name), *f, NUM2INT(extended_type), node_return));
+			NODERUN_EX_E(node, node->createClipNode(CSTR(display_name), *f, NUM2INT(extended_type), node_return));
 			break;
 		case T_STRING:
-			NODERUN_E(node, node->createClipNode(CSTR(display_name), *f, CSTR(extended_type), node_return));
+			NODERUN_EX_E(node, node->createClipNode(CSTR(display_name), *f, CSTR(extended_type), node_return));
 			break;
 		default:
-			rb_raise(rb_eArgError, "extended type must be integer or string");
+			rb_raise(rb_eArgError, "extended type must be integer or string (for instance CLIP, CLIP_SLATE, PROJECT etc.)");
 	}
 
 	return wiretap_node_create_with(node_return, rb_iv_get(self, "@server"), self);
 }
 
-
-static VALUE wiretap_node_destroy(VALUE self) {
+/* Deletes the node from the server */
+static VALUE wiretap_node_destroy_self(VALUE self) {
 	WireTapNodeHandle* node;
+	VALUE is_destroyed = rb_iv_get(self, "@destroyed");
+	if(is_destroyed == Qtrue) {
+	  return Qtrue;
+	}
+	
 	Data_Get_Struct(self, WireTapNodeHandle, node);
-	NODERUN_E(node, node->destroyNode());
+	NODERUN_EX_E(node, node->destroyNode());
 	rb_iv_set(self, "@destroyed", Qtrue);
 	return Qtrue;
 }
@@ -274,7 +282,7 @@ static VALUE wiretap_node_destroy(VALUE self) {
 
 
 /*
- * Extract metadata from node
+ * Extract the node metadata object
  *     @node.metadata
  */
 static VALUE wiretap_node_metadata(VALUE self) {
@@ -295,7 +303,7 @@ static VALUE wiretap_node_metadata(VALUE self) {
 }
 
 
-
+/* Returns the format of the clip */
 static VALUE wiretap_clip_format(VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -308,7 +316,7 @@ static VALUE wiretap_clip_format(VALUE self) {
 	return clipformat;
 }
 
-
+/* Returns the format of the audio node */
 static VALUE wiretap_audio_format(VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -321,7 +329,7 @@ static VALUE wiretap_audio_format(VALUE self) {
 	return audioformat;
 }
 
-
+/* Returns a Wiretap::NodeFrames object that gives access to the frames of the clip */
 static VALUE wiretap_clip_frames(VALUE self) {
 	Check_Node_Alive(self);
 	
@@ -355,22 +363,37 @@ void Init_node() {
 	cLibrary = rb_define_class_under(mWiretap, "Library", cNode);
 	cProject = rb_define_class_under(mWiretap, "Project", cNode);
 	cVolume = rb_define_class_under(mWiretap, "Volume", cNode);
-	cHost = rb_define_class_under(mWiretap, "Host", cNode);
 
+  cSlateClip = rb_define_class_under(mWiretap, "SlateClip", cClip);
+  cHiresClip = rb_define_class_under(mWiretap, "HiresClip", cClip);
+  cLowresClip = rb_define_class_under(mWiretap, "LowresClip", cClip);
+  cSlateClip = rb_define_class_under(mWiretap, "SlateClip", cClip);
+
+	cHost = rb_define_class_under(mWiretap, "Host", cNode);
+  
 	rb_define_alloc_func(cNode, wiretap_node_allocate);
 	rb_define_method(cNode, "id", VALUEFUNC(wiretap_node_get_id), 0);
 	rb_define_method(cNode, "id=", VALUEFUNC(wiretap_node_set_id), 1);
 	rb_define_method(cNode, "reload", VALUEFUNC(wiretap_node_reload), 0);
 
 	rb_define_method(cNode, "metadata", VALUEFUNC(wiretap_node_metadata), 0);
+	rb_define_method(cNode, "meta", VALUEFUNC(wiretap_node_metadata), 0);
+
 
 	rb_define_method(cClip, "format", VALUEFUNC(wiretap_clip_format), 0);
 	rb_define_method(cAudio, "format", VALUEFUNC(wiretap_audio_format), 0);
 	rb_define_method(cClip, "frames", VALUEFUNC(wiretap_clip_frames), 0);
 	rb_define_method(cAudio, "frames", VALUEFUNC(wiretap_audio_frames), 0);
-	
 
+  rb_define_method(cNode, "slate?", VALUEFUNC(wiretap_false), -1);
+  rb_define_method(cNode, "lowres?", VALUEFUNC(wiretap_false), -1);
+  rb_define_method(cNode, "hires?", VALUEFUNC(wiretap_false), -1);
+
+  rb_define_method(cSlateClip, "slate?", VALUEFUNC(wiretap_true), -1);
+  rb_define_method(cLowresClip, "lowres?", VALUEFUNC(wiretap_true), -1);
+  rb_define_method(cHiresClip, "hires?", VALUEFUNC(wiretap_true), -1);
 
+	rb_define_method(cNode, "node?", VALUEFUNC(wiretap_true), -1);
 	rb_define_method(cNode, "host?", VALUEFUNC(wiretap_false), -1);
 	rb_define_method(cNode, "volume?", VALUEFUNC(wiretap_false), -1);
 	rb_define_method(cNode, "project?", VALUEFUNC(wiretap_false), -1);
@@ -394,8 +417,8 @@ void Init_node() {
 	rb_define_method(cNode, "name", VALUEFUNC(wiretap_node_get_name), 0);
 	
 	rb_define_method(cClip, "import_directory", VALUEFUNC(wiretap_clip_import_directory), 1);
-	rb_define_protected_method(cNode, "create_node", VALUEFUNC(wiretap_node_create_node), -1);
-	rb_define_protected_method(cNode, "create_clip", VALUEFUNC(wiretap_node_create_clip), -1);
+	rb_define_method(cNode, "create_node", VALUEFUNC(wiretap_node_create_node), -1);
+	rb_define_method(cNode, "create_clip", VALUEFUNC(wiretap_node_create_clip), -1);
 	
-	rb_define_method(cNode, "destroy!", VALUEFUNC(wiretap_node_destroy), 0);
+	rb_define_private_method(cNode, "destroy_self", VALUEFUNC(wiretap_node_destroy_self), 0);
 }

data/ext/nodeframes.cpp

@@ -6,7 +6,7 @@
 }}
 
 /*
- * Get frames count of clip
+ * Get frame count of clip. Also available as Wiretap::Clip#length
  */
 static VALUE wiretap_node_frames_count(VALUE self) {
 	WireTapNodeHandle* node;
@@ -23,13 +23,20 @@ static VALUE wiretap_node_frames_set_count(VALUE self, VALUE value) {
 	VALUE count = rb_funcall(value, rb_intern("to_i"), 0);
 
 	WireTapNodeHandle* node;
+	
 	Data_Get_Struct(self, WireTapNodeHandle, node);
+	int prev_count;
+	NODERUN_E(node, node->getNumFrames(prev_count));
+  if((prev_count != 0) && (prev_count != NUM2INT(count))) {
+    rb_raise(eError, "Cannot reallocate the frames after the frame length has been set", __FILE__, __LINE__);
+  }
+
 	NODERUN_E(node, node->setNumFrames(NUM2INT(count)));
 	return count;
 }
 
 /*
- * Get frame by index.
+ * Get frame by index. Returns a formatted Stone image buffer as value (a Ruby string).
  */
 static VALUE wiretap_node_frames_get_at(VALUE self, VALUE index) {
 	WireTapNodeHandle* node;
@@ -48,14 +55,13 @@ static VALUE wiretap_node_frames_get_at(VALUE self, VALUE index) {
 }
 
 /*
- * Set frame at index. Accepts the formatted Stone image buffer as value.
+ * Set frame at index. Accepts a formatted Stone image buffer as value (a Ruby string).
  */
 static VALUE wiretap_node_frames_set_at(VALUE self, VALUE index, VALUE value) {
 	WireTapNodeHandle* node;
 	Data_Get_Struct(self, WireTapNodeHandle, node);
-	Check_Type(index, T_STRING);
+	Check_Type(index, T_FIXNUM);
 	Check_Type(value, T_STRING);
-
 	NODERUN_E(node, node->writeFrame(FIX2INT(index), CSTR(value), LEN(value)));
 	return self;
 }
@@ -84,7 +90,7 @@ static VALUE wiretap_node_frames_each(VALUE self) {
 }
 
 /*
- * Get path of frame at index
+ * Get path of frame at index (will include the internal StoneFS frame counter identifier)
  */
 static VALUE wiretap_node_frames_get_path_at(VALUE self, VALUE index) {
 	WireTapNodeHandle* node;
@@ -140,7 +146,7 @@ static VALUE wiretap_node_frame_dump_all(VALUE self, VALUE file_pattern) {
 }
 
 /*
- * Dump one frame to file
+ * Dump the frame at index to an SGI file
  */
 static VALUE wiretap_node_frame_dump(VALUE self, VALUE index, VALUE file) {
 	WireTapNodeHandle* node;
@@ -156,9 +162,8 @@ static VALUE wiretap_node_frame_dump(VALUE self, VALUE index, VALUE file) {
 }
 
 /*
- * Read one frame from a PPM file. If this is the first frame (index 0) and the clip has no frames yet one frame will be allocated.
+ * Read one frame from an SGI, PPM or BMP file. If this is the first frame (index 0) and the clip has no frames yet one frame will be allocated.
  * You cannot change the number of frames afterwards.
- * THIS METHOD SHOULD BE PRIVATE DAMN!
  */
 static VALUE wiretap_node_frame_write_from_file(VALUE self, VALUE index, VALUE filename) {
 	WireTapNodeHandle* node;
@@ -166,32 +171,19 @@ static VALUE wiretap_node_frame_write_from_file(VALUE self, VALUE index, VALUE f
 
 	Data_Get_Struct(self, WireTapNodeHandle, node);
 	NODERUN_E(node, node->getClipFormat(format));
-
-	unsigned int bufSize = format.frameBufferSize();
-	std::auto_ptr<unsigned char> frame(new unsigned char[bufSize]);
-
 	int i = NUM2INT(index);
-	
-	FILE* infile = fopen(CSTR(filename), "r");
-	if(!infile) {
-		frame.release();
-		THROW("Couldn't open file %s for reading", filename);
-	}
-	
-	if(!ppm_read_format(infile, &format)) {
-		frame.release();
-		fclose(infile);
-		THROW("Couldn't read PPM format from file %s", filename);
+
+	std::auto_ptr<ImageIO> image(ImageIO::open(CSTR(filename), format));
+	if(!image.get()) {
+		THROW("Couldn't open file %s for reading", CSTR(filename));
 	}
-	
-	if(!ppm_read_image(infile, frame.get(), format.width(), format.height(), format.bitsPerPixel())) {
+	image->read_format();
+	std::auto_ptr<unsigned char> frame(image->read_data());
+	if(!frame.get()) {
 		frame.release();
-		fclose(infile);
-		THROW("Couldn't read PPM image data from file %s", filename);
+		image.release();
+		THROW("Couldn't read PPM image data from file %s", CSTR(filename));
 	}
-  
-  fclose(infile);
-  
 	int totalFrms;
 	NODERUN_E_FRAME(node, node->getNumFrames(totalFrms));
   
@@ -204,17 +196,27 @@ static VALUE wiretap_node_frame_write_from_file(VALUE self, VALUE index, VALUE f
 	  THROW("You cannot add frames to an existing clip");
 	}
 
-	NODERUN_E_FRAME(node, node->writeFrame(i, frame.get(), bufSize));
+	NODERUN_E_FRAME(node, node->writeFrame(i, frame.get(), format.frameBufferSize()));
 	return self;
 }
 
 
 void Init_nodeframes() {
-	
-	cNodeFrames = rb_define_class_under(mWiretap, "NodeFrames", rb_cObject);
+
+
+  /*
+   * Document-class:  Wiretap::NodeFrames
+   *
+   * Access the frames of a clip. The object can be retrieved via Wiretap::Clip#frames
+   */
+ 	cNodeFrames = rb_define_class_under(mWiretap, "NodeFrames", rb_cObject);
 
 	rb_define_method(cNodeFrames, "count", VALUEFUNC(wiretap_node_frames_count), 0);
+	rb_define_method(cNodeFrames, "length", VALUEFUNC(wiretap_node_frames_count), 0);
+
 	rb_define_method(cNodeFrames, "count=", VALUEFUNC(wiretap_node_frames_set_count), 1);
+	rb_define_method(cNodeFrames, "length=", VALUEFUNC(wiretap_node_frames_set_count), 1);
+
 	rb_define_method(cNodeFrames, "[]", VALUEFUNC(wiretap_node_frames_get_at), 1);
 	rb_define_method(cNodeFrames, "[]=", VALUEFUNC(wiretap_node_frames_set_at), 2);
 	rb_define_method(cNodeFrames, "path_at", VALUEFUNC(wiretap_node_frames_get_path_at), 1);

data/ext/nodemetadata.cpp

@@ -1,7 +1,6 @@
 #include "wiretap.h"
 
 
-
 /*
  * Get count of node metadata entries
  */
@@ -51,7 +50,7 @@ static VALUE wiretap_node_metadata_set_at(VALUE self, VALUE index, VALUE value)
 }
 
 /*
- * eval block on each metadata entry
+ * Run a block on each metadata entry - the metadata stream name and the content of the stream will be passed to the block 
  */
 static VALUE wiretap_node_metadata_each(VALUE self) {
 	WireTapNodeHandle* node;
@@ -70,8 +69,25 @@ static VALUE wiretap_node_metadata_each(VALUE self) {
 	return self;
 }
 
+static VALUE wiretap_node_metadata_stream_names(VALUE self) {
+  VALUE stream_names = rb_ary_new();
+  
+  int i, num;
+
+	WireTapNodeHandle* node;
+	Data_Get_Struct(self, WireTapNodeHandle, node);
+	NODERUN_E(node, node->getNumAvailableMetaDataStreams(num));
+
+	for(i = 0; i < num; i++) {
+		WireTapStr stream;
+		NODERUN_E(node, node->getAvailableMetaDataStream(i, stream));
+	  rb_ary_push(stream_names, wiretap_to_str(stream));
+	}
+	return stream_names;
+}
+
 /*
- * Access to metadata directly.
+ * Access metadata body directly.
  */
 static VALUE wiretap_node_metadata_body(VALUE self) {
 	WireTapNodeHandle* node;
@@ -83,6 +99,8 @@ void Init_metadata() {
 	
 	cNodeMetaData = rb_define_class_under(mWiretap, "NodeMetaData", rb_cObject);
 	rb_define_method(cNodeMetaData, "count", VALUEFUNC(wiretap_node_metadata_count), 0);
+	rb_define_method(cNodeMetaData, "length", VALUEFUNC(wiretap_node_metadata_count), 0);
+  rb_define_method(cNodeMetaData, "streams", VALUEFUNC(wiretap_node_metadata_stream_names), 0);
 	rb_define_method(cNodeMetaData, "[]", VALUEFUNC(wiretap_node_metadata_get_at), -1);
 	rb_define_method(cNodeMetaData, "[]=", VALUEFUNC(wiretap_node_metadata_set_at), 2);
 	rb_define_method(cNodeMetaData, "each", VALUEFUNC(wiretap_node_metadata_each), 0);

data/ext/server.cpp

@@ -3,7 +3,7 @@
 #define Safe_Get_Server(obj, server) do { \
 	Data_Get_Struct(obj, WireTapServerHandle, server); \
 	if(!server) { \
-		rb_warn("Connection to server is already closed on %s: %d", __FILE__, __LINE__); \
+	  rb_raise(eError, "Connection to server already closed on %s: %d", __FILE__, __LINE__); \
 		return Qnil; \
 	} \
 } while(0)
@@ -97,7 +97,7 @@ static VALUE wiretap_server_vendor(VALUE self) {
 }
 
 /*
- * Get product name, installed on server
+ * Get product name of the server
  */
 static VALUE wiretap_server_product(VALUE self) {
 	WireTapStr str;

data/ext/serverlist.cpp

@@ -95,14 +95,14 @@ static VALUE wiretap_server_list_s_allocate(VALUE klass) {
 }
 
 /*
- * Server list doesn't require any params for initialization
+ * ServerList doesn't require any params for initialization
  */
 static VALUE wiretap_server_list_initialize(VALUE self) {
 	return self;
 }
 
 /*
- * resolve server by it's storage ID
+ * Resolve server by it's storage ID
  */
 static VALUE wiretap_server_list_resolve(VALUE self, VALUE storage) {
 	WireTapServerList* server_list;
@@ -122,10 +122,7 @@ static VALUE wiretap_server_list_count(VALUE self) {
 	Data_Get_Struct(self, WireTapServerList, server_list);
 
 	int num = 0;
-	//RUN_E(server_list->getNumNodes(num), server_list);
-	if(!server_list->getNumNodes(num)) {
-		rb_warn("Problem in wiretap: %s. File: %s: %d", server_list->lastError(), __FILE__, __LINE__);
-	}
+	RUN_E(server_list->getNumNodes(num), server_list);
 	return INT2FIX(num);
 }
 
@@ -161,16 +158,31 @@ static VALUE wiretap_server_list_each(VALUE self) {
 }
 
 
+
 void Init_serverlist() {
-	cServerList = rb_define_class_under(mWiretap, "ServerList", rb_cObject);
+/*
+ * Document-class: ServerList
+ *
+ * Use ServerList to autodiscover hosts on the Wiretap network
+ * 
+ *   Wiretap::ServerList.new.each do | server_info |
+ *      puts "Product is #{server_info.product}"
+ *      puts "Server is #{server_info.server}"
+ *   end
+ */
+  cServerList = rb_define_class_under(mWiretap, "ServerList", rb_cObject);
 	rb_define_alloc_func(cServerList, wiretap_server_list_s_allocate);
 	rb_define_method(cServerList, "initialize", VALUEFUNC(wiretap_server_list_initialize), 0);
 	rb_define_method(cServerList, "resolve", VALUEFUNC(wiretap_server_list_resolve), 1);
-	rb_define_method(cServerList, "length", VALUEFUNC(wiretap_server_list_count), 0);
 	rb_define_method(cServerList, "count", VALUEFUNC(wiretap_server_list_count), 0);
 	rb_define_method(cServerList, "[]", VALUEFUNC(wiretap_server_list_get_at), 1);
 	rb_define_method(cServerList, "each", VALUEFUNC(wiretap_server_list_each), 0);
 
+/*
+ * Document-class: ServerInfo
+ *
+ * Gets returned from ServerList to describe a Wiretap host that you can connect to
+ */
 	cServerInfo = rb_define_class_under(mWiretap, "ServerInfo", rb_cObject);
 	rb_define_method(cServerInfo, "hostname", VALUEFUNC(wiretap_server_info_hostname), 0);
 	rb_define_method(cServerInfo, "version", VALUEFUNC(wiretap_server_info_version), 0);

data/ext/wiretap.cpp

@@ -3,18 +3,20 @@
 
 VALUE mWiretap, mPPM, cServer, cNodeChildren, cServerList, cServerInfo;
 VALUE cClipFormat, cAudioFormat, cNodeMetaData, cNodeFrames, cAudioFrames;
-VALUE cNode, cHost, cVolume, cClip, cAudio, cReel, cLibrary, cProject;
-VALUE eError;
+VALUE cNode, cHost, cVolume, cClip, cHiresClip, cLowresClip, cSlateClip, cAudio, cReel, cLibrary, cProject;
+VALUE eError, eConcurrentLockError;
 ID to_i;
 
 VALUE wiretap_to_str(WireTapStr& str) {
 	return rb_str_new(str.c_str(), str.length());
 }
 
-
+/* Always returns false for this object */
 VALUE wiretap_false(int argc, VALUE* argv, VALUE self) {
 	return Qfalse;
 }
+
+/* Always returns true for this object */
 VALUE wiretap_true(int argc, VALUE* argv, VALUE self) {
 	return Qtrue;
 }
@@ -43,16 +45,17 @@ void Init_wiretap_bin() {
 	to_i = rb_intern("to_i");
 	
 	mWiretap = rb_define_module("Wiretap");
+	rb_define_const(mWiretap, "CLIENT_VERSION", rb_str_new2(VERSION));
 	eError = rb_define_class_under(mWiretap, "Error", rb_eStandardError);
-	
+	eConcurrentLockError = rb_define_class_under(mWiretap, "LibraryLocked", eError);
+
 #ifdef HAVE_SNDFILE_H
-	rb_define_singleton_method(mWiretap, "supports_audio?", VALUEFUNC(wiretap_true), -1);
+	rb_define_const(mWiretap, "AUDIO", Qtrue);
 #else
-	rb_define_singleton_method(mWiretap, "supports_audio?", VALUEFUNC(wiretap_false), -1);
+	rb_define_const(mWiretap, "AUDIO", Qfalse);
 #endif
 	
-	Init_ppm();
-	
+
 	Init_server();
 	Init_node();
 	Init_children();

data/ext/wiretap.h

@@ -2,6 +2,7 @@
 #define _WIRETAP_H_
 
 #include <WireTapClientAPI.h>
+#include <WIRETAP_VERSION>
 #include <ifffsWTTypes.h>
 #include <stdlib.h>
 #include <stdio.h>
@@ -11,9 +12,11 @@
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <stdarg.h>
-#include "image.h"
 #include <memory>
 
+#include "frame_io.h"
+#include "image_io.h"
+
 
 #ifdef __cplusplus
 #  ifndef RUBY_METHOD_FUNC /* These definitions should work for Ruby 1.4.6 */
@@ -55,6 +58,17 @@
 #define NODERUN_E(node, x) RUN_E(x, node)
 #define SERVERRUN_E(server, x) RUN_E(x, server)
 
+// A special wrapper to be used when we might potentially stumble upon concurrency problems with locked
+// libraries (typical for IFFS). We use a special macro for this to be able to catch concurrency errors and
+// raise accordingly
+#define NODERUN_EX_E(container, expr) {if(!(expr)) { \
+  if(strstr(container->lastError(), "locked")) { \
+  	rb_raise(eConcurrentLockError, "%s. File: %s: %d", container->lastError(), __FILE__, __LINE__); \
+  } else { \
+  	rb_raise(eError, "Problem in wiretap: %s. File: %s: %d", container->lastError(), __FILE__, __LINE__); \
+  } \
+}}
+
 #define Check_Node_Alive(node) \
 if(rb_iv_get(self, "@destroyed") == Qtrue) { \
 	rb_warn("Node is already destroyed"); \
@@ -82,10 +96,6 @@ void Init_children();
 void Init_metadata();
 void Init_nodeframes();
 
-void Init_ppm();
-bool ppm_read_format(FILE* f, WireTapClipFormat* format);
-bool ppm_read_image(FILE* f, unsigned char* frame, int width, int height, int bpp);
-
 
 void Init_image_format();
 bool wiretap_write_image_frame(int width, int height, int bpp, unsigned char* frame, const char* filename);
@@ -99,17 +109,11 @@ void Init_thread_worker();
 extern "C" {
 	void Init_wiretap_bin(void);
 	extern VALUE mWiretap, mPPM, cServer, cServerList, cServerInfo;
-	extern VALUE cNode, cHost, cVolume, cClip, cAudio, cReel, cLibrary, cProject;
+	extern VALUE cNode, cHost, cVolume, cClip, cHiresClip, cLowresClip, cSlateClip, cAudio, cReel, cLibrary, cProject;
 	extern VALUE cNodeChildren, cNodeFrames, cAudioFrames, cNodeMetaData, cClipFormat, cAudioFormat;
-	extern VALUE eError;
+	extern VALUE eError, eConcurrentLockError;
 	extern ID to_i;
 
 }  /* extern "C" { */
 
-
-
-
-
 #endif
-
-