CStream, V1.0 README

Copyright WPI, 2011

Author: Thangam Vedagiri Seenivasan
Contact: Mark Claypool (claypool@cs.wpi.edu)

See also:

  Thangam Vedagiri Seenivasan. CStream: Neighborhood Bandwidth
  Aggregation For Better Video Streaming, M.S. Thesis, Computer
  Science Department, Worcester Polytechnic Institute, Spring
  2010. (Advisor Mark Claypool) Online at:
  http://www.cs.wpi.edu/~claypool/ms/cstream/



#######################
# AVI Library         #
#######################

The CStream code uses the C# file wrapper for AVI Library from
http://www.codeproject.com/KB/audio-video/avifilewrapper.aspx.  Below
is the copyright information in the AVI Library files

/* This class has been written by
   * Corinna John (Hannover, Germany)
   * cj@binary-universe.net
   * 
   * You may do with this code whatever you like,
   * except selling it or claiming any rights/ownership.
   * 
   * Please send me a little feedback about what you're
   * using this code for and what changes you'd like to
   * see in later versions. (And please excuse my bad english.)
   * 
   * WARNING: This is experimental code.
   * Please do not expect "Release Quality".
   * */

#######################
# General Information #
#######################

The project has three components
1. Server
2. Client
3. Helper(s)
(details in thesis)

Setup
-----
See the Implementation section in the thesis.


Running the components
----------------------
Create Adhoc-Network between client and helper nodes

Run the components in the following order: Server, Helper(s), Client

Server
------
- Open Server/ServerTest/ServerTest.sln in Visual Studio
- In ServerComponents/Settings.cs, change ServerIPAddress to the
  ethernet IP address of that machine
- Run the project
- There are 2 video files in ServerTest/bin/Debug (cartoon.avi and
  foreman.avi). You can add more.


Helper
------
- Open Helper/HelperTest/HelperTest.sln in Visual Studio
- In HelperComponents/Setting.cs, change ClientIPAddress to the WiFi
  IP address of the client (see details of client below)
- In HelperComponents/Utils.cs, change the IPAddress in the
  GetEthernetIPAddress() function to the ethernet address of this
  helper.
- Run as many helpers as you want in different machines.


Client
------
- Open Client/ClientTest/ClientTest.sln in Visual Studio
- In ClientComponents/Settings.cs, change ServerIPAddress to the
  ethernet IP address of the server
- In ClientComponents/Utils.cs, change the IPAddress in
  GetEthernetIPAddress() and GetWiFiIPAddress() to the ethernet and
  wifi IP address of this client respectively.
- Run the project.
- Request video using using the text box and client Play.