Multimedia applications often have interactive elements based on video: For example, a pre-rendered 3D scene that moves according to a user’s interaction. The trick, in such a scene, is to play specific parts of the movie forward and backward to fake movement.

This sculpture has been rendered as a movie, with the camera panning 360˚around the object.
(Drag with the mouse to turn the object)

Embedding Animations

There are three basic ways to embed an animated scene into Flash:

• In the Flash Video format (FLV);
• As a sequence of images, e.g. PNG or JPEG;
• As a sequence of vector graphics.

The latter is often forgotten. Tools such as Cinema 4D’s FlashEx renderer can export a scene as a vector animation. If the scene doesn’t contain many objects and has simple texturing, a vector animation would probably be the way to go. The file size stays relatively small, plus the graphics are scalable.

A simple 3D object rendered as a vector sequence with FlashEx 2.
(Drag with the mouse to turn the object)

The other two methods, FLV and image sequences, are both pixel based, but have their own pros and cons. FLV has a decent quality/size ratio. Flash CS4 does not allow F4V files to be embedded directly, so the best codec is the older and less compressing On2 VP6. Interacting with FLV, e.g. jumping between frames quickly or playing it backward, is heavy on the processor. Presumably, the Flash Player has to jump to the nearest proceeding keyframe and process the changes to the current frame each time. On the other end of the spectrum is the image sequence. The compression is on a per-frame basis, so the overall file size will usually turn out much bigger. The display performance, however, is far better than FLV.

Eliminating the Cons

A combination of the reduced file size of FLV and the performance of an image sequence is possible, if the data gets decompressed on the client side. H.264 encoded video data could be sent through the wire and then be processed into an uncompressed image sequence before being displayed. I wrote a class named BitmapAnimation that parses each frame of a MovieClip (including any FLVs within) and adds it to an array of bitmap data. BitmapAnimation has the same methods as a MovieClip (gotoAndPlay, currentframe etc.), so the two can be interchanged. For instance, I was able to use a BitmapAnimation in place of a MovieClip to create a MovieMaterial in Papervision3d – polymorphism works.

When compared with simultaneously running FLVs, BitmapAnimations showed a 500% performance increase on my system. The difference was even bigger with the clips running backward. There may be a performance benefit in converting complicated vector animations to a BitmapAnimation before they are displayed. I have, however, not recently come across a scenario where a pure vector animation alone caused the frame rate to stagnate.

The MovieClip option cacheAsBitmap requires, to my understanding, the frame to be rendered in the Flash display list before it takes effect. This would be the only major difference to BitmapAnimation (where the image is rendered before being displayed). Enabling cacheAsBitmap on MovieClips containing FLV did not show a change in performance in my tests. Because a video is usually viewed once, it makes sense not to cache FLV by default.

There is one known drawback when using a BitmapAnimation: Depending on the size of the video and the client’s processor speed, the Flash Player could “freeze” for a few seconds while decompressing the video data. I created an additional class, where I lengthened the processing time by decompressing one frame per half-second. This would allow the video to be prepared in the background without noticeably slowing down the rest of the application. Delayed processing would work best during a loading sequence, where the video is loaded first, then converted to a BitmapAnimation, while the rest of the assets are being retrieved.

Usage

Simply pass a MovieClip to the draw method.

bitmapAnimation = new BitmapAnimation();
bitmapAnimation.draw(movieClip);
addChild(bitmapAnimation);

The imported bitmap data can be reused with multiple BitmapAnimations.

var bitmapAnimation1:BitmapAnimation = new BitmapAnimation();
bitmapAnimation1.draw(movieClip);
var bitmapAnimation2:BitmapAnimation = new BitmapAnimation(bitmapAnimation1.bitmapSequence);

Conclusions

Pre-rendering a complex MovieClip, such as embedded FLV, using the BitmapAnimation class, may likely show a performance increase. Also, this method may remove the need to embed an image sequence where display performance is an issue. Due to the computation time required for conversion, BitmapAnimations should not be used for long clips. Inputs and feature requests are welcome, just add a comment below.

Download the classes BitmapAnimation and DelayedBitmapAnimation.

Download the blimp example.

A lesser known feature of browsers, such as Firefox 2 or Internet Explorer 7, is that users can add search functionality to the browser’s search bar directly from within a page. The data structure containing the search information has (so far) been agreed upon as OpenSearch. Since the format is open, any browser software can implement this functionality.

The Firefox search bar with a linked OpenSearch example on the bottom.

The Internet Explorer search bar listing an OpenSearch example.

When to use OpenSearch

OpenSearch makes sense on any site that provides search functionality. When active, Firefox and Internet Explorer include an option to add the site’s search in the search bar.

In my opinion, adding a notice or a link on the page to enable the search functionality is overkill for most sites. I personally wouldn’t use it for my own weblog. On the other hand, an online store with thousands of products could greatly benefit from this feature as a brand touchpoint; And informing the user about this functionality would be worthwhile. Once a user adds a site to their browsers search bar, it is a constant reminder of the site’s existence. Every time a user activates the search bar drop-down menu, that site will be there.

Implementation

Versions of Firefox before 2.0 had a different way for adding search to the search bar. It was similar, but included a different XML structure. The data was saved in files ending with “.src”. I decided not to add this method anymore, since it is specific to a small user base (who still uses FF 1.0?).

Only two things need to be done to add OpenSearch:

1. Create an XML-File containing data about the search engine;
2. Link to the XML-File in the head of the site’s HTML.

The XML, for example, would be structured as follows; Simply adapt the URLs for your site. To get the correct search URL, perform a search on your site, copy the URL and replace your search term with “{searchTerms}”.

<?xml version="1.0" encoding="UTF-8" ?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
	<ShortName>OpenSearch Example Name</ShortName>
	<Description>OpenSearch Example Description</Description>
	<InputEncoding>UTF-8</InputEncoding>
	<Image height="16" width="16" type="image/x-icon">http://yoursite/favicon.ico</Image>
	<Url type="text/html" template="http://yoursite/?s={searchTerms}" />
</OpenSearchDescription>

This file could then be saved as “search.xml” to the root folder of the site and linked to by placing the following code in the HTML header:

<link rel="search" type="application/opensearchdescription+xml" title="OpenSearch Example Title" href="/search.xml">

Including an OpenSearch Link to the Page

window.external.AddSearchProvider("search.xml");

An unobtrusive way to add the link, is to first check if the browser supports the AddSearchProvider function before adding it. Further details can be found on Mozilla’s developer site.

<p id="add-opensearch">OpenSearch not supported</p>
<script type="text/javascript">
	if (window.external && ("AddSearchProvider" in window.external)) {
		document.getElementById("add-opensearch").innerHTML = '<a href="#" onclick="window.external.AddSearchProvider(\'/search.xml\')">Add this site’s search to your browsers search bar.</a>';
	}
</script>

Possible Future Browser Features

I have a hunch that the usability of web-browsing in general, would be enhanced if the browser could detect OpenSearch and enable it temporarily in its search bar. The use case could be:

A user visits a site and the browser toggles the search bar to the site’s search. Instead of looking for a search form in the page, the user enters the query via the browser. Upon leaving the site the search bar switches to the new site’s search functionality, or defaults to the preferred search engine.

The search bar could be highlighted with another color to indicate that it’s linked to the current site.

For this feature to be useful, OpenSearch would have to become more commonly adopted. But I think sites would follow quickly once a browser vendor starts pushing the feature.

Conclusion

In my opinion, the creators of OpenSearch got it right. The specification is clear and it blends in perfectly with the existing technologies, HTML and Javascript. Plus, it is quick and easy to implement. I could recommend any web content management system with search functionality to enable this feature as standard.

I would also recommend adding a favicon to the OpenSearch XML, so the site stands out more in the browser’s search bar.

Download the Code

Small brick and mortar stores run on a tight budget and often rely on open source software for managing inventory. I will discuss the setup I have made for a boutique that is running both a physical and online store.

Scenario

If you extend an existing B&M store with an online shop, you will eventually run into a problem synchronizing your product inventory. Running two separate inventories may be a hassle, especially if you start moving products out of the store and into the online shop or vice versa.

A Simple Solution

Treat both inventories as one. The same item could be on display in both the physical and online stores. Better yet, use the physical store as the storage room for the online store – eliminating the need to pay rent for extra space.

The in-store items can be sold via the online shop at the same time. (photo by Gastev on Flickr)

The biggest hurdle, using this solution, is the booking of a physical product sale to the online database. This would have to happen ASAP, so the same product can’t be bought twice (by separate customers in both realms). A possible way, would be to use a computer as the point of sales and book directly to the online database. I had an iMac connected to a USB receipt printer and cash drawer. However, this setup did not last. It requires the computer to be online in order to book a purchase. What happens when the internet connection is lost with a line of customers to attend to? Murphy would predict this to happen. Even a slow internet connection lengthens the purchasing process unnecessarily, and nobody likes to wait at the register. Optimally, the POS software could have a caching mechanism and then synchronize the purchases with the online shop as soon as it’s back online.

I have chosen to revert to the “non-software-reliant” way of tackling this problem: Use a classic cash register for handling the money transaction. It’s fast and reliable; The cash register does not need to know anything about the inventory. During the purchase process, note the numbers of the products being sold; Using pen and paper, in your head, whatever is fast (and reliable).

Speaking of product numbers. The inventory in the database is usually numbered continuously (e.g. the first product in the database is number 1, then number 2 and so forth). Tag the actual product with that number. The shop I have this solution running in hasn’t yet reached 5 digit product numbers. This makes the number easier to handle than a long EAN code.

Soon after a physical purchase, when all customers are attended to, connect to the administration section of the online shop and enter the product numbers that have been purchased. I will later discuss a module I programmed to streamline this process.

Working this way, the product numbers do have to be remembered/written twice (during the purchase and while synchronizing with the database), but it improves the customer experience by removing the time it takes to handle the software.

The Software

I use the open source software named Zen-Cart to manage the product inventory. It was, in my opinion, the best option when I first created the shop in 2006. There are many newer and better projects out there in the meantime, such as Magento, OFBiz, and Spree.

I adapted the Zen-Cart checkout process to allow client-side technologies such as Javascript and Flash to call it. I have also created a Zen-Cart module that books purchases based on a list of product numbers. It takes a few seconds to complete: for instance just enter “23, 612, 5, 1209” into the form and hit enter. Each purchase is entered into the database, as if it where bought online using the original checkout process.

The project is hosted on Google code. It will need some tweaking to work, so PHP and Javascript knowledge is required. Download the services here.

Conclusion

The described solution, where I moved the step of booking into the online database to the end of the purchase process, has worked well since it has been initiated in 2007. If anybody has an even simpler solution to run a physical and online store in parallel, please leave a comment.

I watched a useful presentation about form design by Ryan Singer a while back and he makes a point that user input should be kept to the bare minimum when signing up. An article by Luke Wroblewski titled Sign Up Forms Must Die seconds the notion.

However, sometimes it is required for the user to do the leg-work and fill in lots information. Like registering at an online store for instance. Gotta at least know where to send the purchased goods! For users that don't have auto-fill plugins such as the Google Toolbar, Javascript can help filling in the necessary information - not just validating the user input. It would, for instance, make web forms simpler for users if their city would be filled in automatically upon entering their postcode. I timed myself typing my city of residence as quickly as possible and it took me about 3 seconds. So, all in theory of course, the improvement would skim roughly that much time off filling in a form. It's not a lot, but the users level of tolerance towards HTML forms isn't much either.

I'm now going to talk about how I “auto-fill” the city information based on the entered postcode in a HTML form using PHP, MySql and Javascript.

Setting Up the Database

First I needed to get the postcode information from somewhere. For Switzerland I found the data via the Swiss Post.

Then I needed to get it into the database somehow. To do this I imported the downloaded text file (it is tab delimited) into Excel and then exported it again as a CSV file. I only imported the columns I needed which are the ones containing the Town name and the postcode.

Next I put on my white programming gloves and wrote a quick PHP script that connects to the database and runs two SQL statements to import the CSV file. Change the variables to fit your setup and be sure to have the CSV file in the same folder when you run the following example.

$link = mysql_connect('localhost', 'root', 'root') or die('Could not connect: ' . mysql_error());

mysql_query("CREATE DATABASE IF NOT EXISTS test
DEFAULT CHARACTER SET latin1 
COLLATE latin1_swedish_ci;"
);

mysql_select_db('test') or die('Cannot select database');

mysql_query( "CREATE TABLE postcodes (
code SMALLINT(4) NOT NULL ,
city VARCHAR(27) NOT NULL ,
PRIMARY KEY (code)
) ENGINE = MYISAM CHARACTER SET latin1 COLLATE latin1_swedish_ci"
);

mysql_query( "LOAD DATA LOCAL INFILE 'postcodes.csv'
INTO TABLE postcodes
FIELDS TERMINATED BY ','
LINES TERMINATED BY '\r\n'
(code, city);"
);

if(mysql_error()) echo mysql_error();
else echo "Done!";

mysql_close($link);

Special characters where also an issue with importing and exporting so be sure to check the city names in the database. I used the windows text format for importing.

Creating a Web Service

We now need some server side code to provide us with the data from the database. I am using the insanely cool JSON gateway included with AMFPHP to provide the client with data. So with AMFPHP set up I could just write a simple PosteCodeFinder class and plop it into the AMFPHP's services folder. Otherwise a simple way to get the correct name would be a PHP script like this:

mysql_connect('localhost', 'root', 'root') or die('Could not connect: ' . mysql_error());
mysql_select_db('zencart_shop') or die('Cannot select database');

if (isset($_GET['code']) && is_numeric($_GET['code'])) $code= $_GET['code'];
else die ('Only numbers please! The URL should look something like: postcodefinder.php?code=1000');

$query = "SELECT city FROM postcodes WHERE code =" . $code . " LIMIT 0 , 1 ";

header("Content-Type: text/javascript; charset=utf-8");
echo json_encode(utf8_encode(mysql_result(mysql_query($query), "city")));

The code connects to the database, checks the input to be numeric, retrieves the city name and spits it out as JSON.

I had to use utf8_encode() inside the json_encode() function because it would otherwise mess up my character encoding. "Genéve", for instance, would be truncated to "Gen". It was reported as PHP bug #43941.

The Client-Side Code

On to the Javascript! I am using the Prototype library here to make programming AJAX bearable.

FormController = {
	previousResponse: "",
	
	postcodeHandler:function(el) {
		var code = parseInt(el.value);
		if (code >= 1000 && code <= 9999 && $F('country') == 204) 
	  	new Ajax.Request(
			"json.php/PostCodeFinder.find/" + code, 
			{
	  		method: "get",
	  		onSuccess: FormController.updatePostCode.bindAsEventListener(this)
	  		}
		);
	},
	
	updatePostCode:function(transport) {
		var jsonObj = eval("(" + transport.responseText + ")");
		if (jsonObj != undefined && ($F('city') == "" || $F('city') == previousResponse)) {
	   	$('city').value = jsonObj;
			this.previousResponse = jsonObj;
	   }
	}
}

Event.observe(
	window,
	'load',
	function() {
		new Form.Element.Observer('postcode', 1, FormController.postcodeHandler.bindAsEventListener(this));
	}
)

Download all the code here.

Conclusions

Usability Gain

Considering the amount of time it took me to implement, I can only recommend the postcode optimization as a final improvement to a form. Other factors, as mentioned in Singer's video for instance, should be considered first to get the most bang for the buck.

Character Encoding

Most of my time was not spent with programming the scripts but with playing with the character encoding. Having UTF-8 all the way through form the original text file, to the database, to the PHP script, to the client side Javascript and finally the HTML document itself was easier said than done. I found a PDF on the UTF-8 development practices by Matthias Kerstener, that helped out with some of the issues. Still, character encoding issues makes me not want to be a web developer any more.