Red5 Backwards Compatibility Report

February 5, 2009

Update Period

23-JAN-2009 to 05-FEB-2009

Summary

A lot of bug fixes but we don’t anticipate any backwards compatible impacts in this report. 0.8.RC2 is looking good and will ship this week (although deploying Red5 as a WAR file in tomcat, and the Windows installers will not work).

We will then move onto 0.8.RC3 which will hopefully fix those issues, as well as introduce a new feature: Listeners that return false will cause calling methods to abort (e.g. appStart()). Previously return values on Listeners were ignored. This change is unlikely to break any apps (convention on listeners is to return true), but we’re giving you a heads up on this change here. Enabling it lets you do much cooler things with your Listeners.

Major New Features

Feature What it Means
Lots of bug fixes for RC2 A lot of bug fixes were added in the last two weeks, many of them based on patches from the community. Keep it up!

Also our system-tests were augmented with additional tests to ensure the fixed AMF3 bugs stay fixed.

Red5 Continuous Build Server now publishes “pre-compiled” packages:
Java 1.5
Java 1.6
The continuous build server now creates pre-compiled complete downloadable snapshots (in ZIP and .tar.gz formats) so you can download a stable-build and run without having to compile Red5 yourself.

Changes With Compatibility Impacts

Revision Description
R3424 Upgraded to Ivy 2.0 Final

More Details

For details on these and all other changes to red5:
http://code.google.com/p/red5/updates/list

Previous Reports

You can find the last report here.

What Is This Report

Red5 is under active development and as such APIs and the implementation are subject to change at any time.

To help with that problem and as a service to the Red5 team, every two weeks Xuggle publishes updates giving a summary of major changes since the last report that MAY require changes to your existing Red5 applications.

Other changes may have been made as well, but we do not expect them to cause backwards compatibility issues.

See here for more background.


Red5 0.8.RC2 Second Candidate

February 3, 2009

Red5 Logo

Red5 0.8 RC2 final release is here! Go there and use that version rather than what is here.

Thanks for everyone’s help testing the first candidate.  Now as promised, here is our second, and (hopefully) final candidate build for Red5 0.8 RC2.

All known issues that we’re planning to fix for 0.8 are fixed in this release.

Thanks to everyone who contributed patches and fixes — they were invaluable to get to this stage.  Special shout out as usual to Mondain who worked through the weekend with other members of the community to patch the remaining AMF3 bugs we were trying to squash.

Candidate Builds

Java 1.6: build #27

Linux & Mac Download | Windows Download

Java 1.5: build #28

Linux & Mac Download | Windows Download

Installation Instructions

First, make sure you have the environment variable JAVA_HOME set to the Java version you want to use.

Linux & Mac OS-X

Download the latest .tar.gz file and run (assuming the file is named red5-release.tar.gz)

tar -xzvf red5-release.tar.gz

Then cd into the directory that was unzipped and do:

export RED5_HOME=`pwd`
./red5.sh

This will start up the red5 server on your machine. Connect to http://localhost:5080/ (assuming you’ve installed on localhost) and you should be up and running.

Windows

Download the latest .zip file and unzip it to a new directory.  Then set a windows environment variable called RED5_HOME to point to that directory.  Finally, run:

red5.bat

This will start up the red5 server on your machine.  Connect to http://localhost:5080/ (assuming you’ve installed on localhost) and you should be up and running.

Testing Instructions

Here’s the things we’d like you to check:

  • Make sure the server starts up and you can connect to the main page
  • Watch the instruction video for how to install demos and run them (and give me feedback).
  • Make sure you can install the oflaDemo demo application under Java 1.6 and Java 1.5
  • Make sure you can connect and use the http://localhost:5080/demos/ofla_demo.html application.
  • Make sure you can connect and use the http://localhost:5080/demos/publisher.html, connecting to rtmp://localhost/oflaDemo
  • Install the SOSample demo application under Java 1.6
  • Connect to http://localhost:5080/demos/BallControl.html with multiple web browsers, and make sure when you move the ball in one browser that it moves on the other browsers as well.

What Are The Already Known Issues

There are, as with all products, some bugs, but in general we’re quite happy with this release.

The Echo Test application will fail on some tests; they are known failures but they are in “underspecified” scenarios (e.g. sending an ActionScript 3 XML object over AMF0 fails, but in theory AMF0 doesn’t support sending raw XML anyway).  We do not plan to fix these for 0.8 but hope to fix them in a later release.

To see the complete list of bugs we’re tracking for 0.8.RC2 (and the ones we’ve already decided to delay until after 0.8), click here.

What To Do If You Find a Bug

How to File a Bug

If you find a bug, please let us know by:

  1. Check the bug database to make sure there isn’t already a bug file; if there is, add your comments there.
  2. If there isn’t already a bug, file a new one here and assign it to Art Clarke.
  3. Make sure you include the following information
    1. SVN revision or official build of Red5 you are running
    2. Java version you are using.
    3. Operating system you are running on.
    4. Any red5 logs that show the problem.
    5. A complete description (more detail is better) of how to reproduce the problem.
    6. What your JAVA_HOME and RED5_HOME environment variables are set to.

How to Fix A Bug

Even better than filing a bug, is also filing a patch to fix it.  To maximize your odds that we’ll include your fix, we ask you to try to do as many of the following steps as possible:

  1. Test the fix with the latest tip of tree in your environment.
  2. Run “ant run-tests” and make sure all tests pass 100% with your fix.
  3. Run “ant run-tests-server”, and then in a web browser open up test/fixtures/red5-selftest.swf (in the red5 build tree).  Make sure your camera is enabled and that all tests pass 100%.
  4. Create a new JUnit unit test that will fail before your patch (i.e. shows the bug) and passes after the patch.
  5. If you can, follow the Red5 Testing Guide, and create a new flash system test that tests your patch.
  6. Submit a patch by running “svn diff” from the top of the tree and attaching it to the bug, along with the SVN revision number of Red5 you made your modifications in.
  7. If you created a JUnit test, submit as a different patch.
  8. If you created a ASUnit test, submit as a different patch.

Priority will be given to bugs that have patches filed with them.  TOP PRIORITY will be given to bugs with tests and patches.

What’s Next

We’re going to give this 2-3 days to bake, and if it still looks good, we’ll create windows installers and post the final 0.8.RC2 version.

Then we’ll move onto 0.8.1, which has a few new features we’re excited about.  Stay tuned.

- The Red5 Team


Tutorial on installing the Red5 Admin Panel

February 2, 2009

Antoni Jakubiak has put together a great tutorial telling you how to run the Administrator’s panel in Red5 0.8.RC2.  Check it out!

He’s also put together a review of Xuggler you might want to check out too.

- Art