IBM Bamba OS/2 Plug-In (Version 1.1) ==================================== License Agreement ----------------- Please read the enclosed IBM Alphaworks license agreement file LICENSE.TXT carefully. Your use of the software or any related documentation indicates your acceptance of the terms and conditions therein. If you do not agree to those terms and conditions, you may not install or use the Software. PreRequisites ------------- * OS/2 Version 4.0 (Merlin) or OS/2 Version 3.0 with FixPak 26 (or greater) applied * Netscape for OS/2 Version 2.02 GA * Video adapter running in greater than 256 color mode. e.g. 16-bit 65536 color or 24-bit 1677216 color - see Restrictions section below for more information * Audio card for sound at 8000Hz - see Problem Determination below for more information Installation Instructions ------------------------- Automated installation ....................... The following instructions apply whether you are a new user or are upgrading from an older version that was also installed using the install.cmd utility. If you already have a version, which was not installed using this install utility, or you chose to install manually, then please refer to the 'Automatic installation over prior manual installation' section below before proceeding. There you can check to see if this automatic utility is able to correctly upgrade your installation (basically if you followed earlier recommendations and installed the DLLs into \MMOS2\DLL it will do so correctly) 1. Exit Netscape Navigator if it is running 2. Run the BOS2A in a temporary directory. This is a self-extracting EXE that will create the following files in that directory. BMBLBRA.DLL BMBLBRV.DLL BMBOM30.DLL NPBAMBA.DLL DAUDIO.EXE DAUDIO.WAV LICENSE.TXT README.TXT (this file) INSTALL.CMD DAUDIO.EXE and DAUDIO.WAV are test files - see the Audio Support topic in Problem Determination section below for more information. 3. Type INSTALL which will run the INSTALL.CMD utility and moves the Bamba plug-in DLL files to appropriate directories ready to run. The install will also prompt if you wish to view this readme and also recommends testing your audio especially if this is your first installation. Any existing Bamba installation found will be backed up by the install into a bbbackup directory in the Netscape plug-ins directory. If you prefer to install manually then the steps necessary are listed below (this is what the install does for you too). 4. You may now restart Netscape Navigator 5. Any files that were extracted and that are still present in the temporary directory may be deleted at this time if you wish. You may want to keep this readme for future reference. Automatic installation over prior manual installation ..................................................... NOTE: If you are upgrading a version of this plug-in, which you installed manually, and you did not choose the recommended directory (\MMOS2\DLL) in which to move the three BMB*.DLL files (or you did not put them in \OS2\DLL) then the install utility will not work for you. It will not correctly detect this previous version and the resultant installation may not work. In this case please first locate where you installed the three DLLs and delete them by hand (back them up first in case you wish to revert to the older version) before running the INSTALL (You can locate these files quickly by doing a "DIR x:\BMB*.DLL /S" where x: is the drive letter). The new INSTALL will put these files in the directory \OS2\DLL and will correctly update any files found in either \MMOS2\DLL or \OS2\DLL (new DLLs are only put in \OS2\DLL - any in \MMOS\DLL will be removed by the install). Manual install procedure ........................ Should you wish to do step 3 of the installation manually this is what you should do. You DO NOT need to do this if you run the INSTALL utility as it does this automatically for you. i. Move BMBLBRV.DLL, BMBLBRA.DLL and BMBOM30.DLL to a location in your libpath. (we strongly recommend \OS2\DLL to be compatible with the installation utility) Note: If you are upgrading from an older version please ensure you overwrite the older versions of these DLLs in the directory from the libpath where you originally installed them. ii. Move NPBAMBA.DLL to your Netscape plugin directory i.e. \NETSCAPE\PLUGINS. Restrictions ------------ 1. Video color support From the "System" icon on your OS/2 desktop, set your screen resolution to greater than 256 color depth. Running at 256 color depth or less will result in poor video quality. Problem Determination ---------------------- 1. Audio support If you don't hear any audio or you get a popup message complaining about the capabilities of your audio device, it may be that your audio card doesn't support the audio sample rate or size used by the OS/2 Bamba plug-in. If you want to verify the capabilities of your audio card DAUDIO.EXE and DAUDIO.WAV are provided. Ensure both of these files are in the same directory and execute DAUDIO. If this fails your audio card is not supported by Bamba under OS/2. It may be that you can load a newer audio device driver to enable this support. You can find a list of drivers on the web at the "OS/2 Device Driver Pak On-Line" at http://service.software.ibm.com/os2ddpak/index.htm If you are running OS/2 Version 3.0 then ensure that you have at least FixPak 26 applied. Change History -------------- * Updated Version 1.1 package to add install - Install utility added, otherwise code is unchanged. Changed recommended directory, in this readme, for support DLLs from \MMOS2\DLL to \OS2\DLL as per the install.cmd (allows video-only clips to be played when MMOS2 not installed). * Version 1.1 - Remove gethostbyaddr() when using dotted IP address for live URL * Version 1.0 - Supported for playing live streams added - Some user interface changes - Various bugs corrected * Version 0.2 - Various bugs causing errors such as SYS3175 exceptions corrected - Buttons added for Rewind, Pause, Play and Info. - EMBED tag parameters now parsed and acted upon (see below) - Supports multiple clip instances on a single web page - Support for obsolete .vba format removed * Version .01 - First version released to IBM alphaWorks EMBED tag syntax ---------------- Bamba clips are placed in an HTML page using an tag. The OS/2 Bamba player supports a sub-set of the attributes defined for the Windows version. This subset is as follows. WIDTH and HEIGHT attributes are mandatory; SRC is mandatory for the playing stored clips; TYPE and URL are mandatory for playing live streams - all other attributes are optional and will assume default values when not present. TYPE This specifies the MIME type of the stream and is mandatory for live streaming so that the browser can determine which plug-in, in our case Bamba, to load to play the stream. This must be set to "video/x-ibmbamba" when present. SRC Specifies the HTTP URL for the "iba" file. Mandatory for stored clips. LIVE When set FALSE (default) the SRC attribute must be used as this combination specifies playing a stored file. When set TRUE the MIME type is required, AUDIOPORT/VIDEOPORT specify the live stream port numbers to use to contact the broadcast source at the address given by the URL live source address attribute. URL Mandatory if LIVE is set TRUE. This specifies the source IP address of the live broadcast stream. AUTOSTART When set FALSE (default) if the Play button must be used to start the clip playing. When set TRUE the clip will automatically start playing when the page is loaded. Note: Only one clip on a page containing audio can autostart in this way (if multiple clips are set to autostart then only the first one loaded will actually start playing) AUDIO VIDEO The AUDIO attribute or VIDEO attribute may be set FALSE to prevent that content of the clip from being played. Eg a clip containing both video and audio can be set to play only the audio by setting VIDEO=FALSE. Setting an attribute to TRUE will have no effect if there is no corresponding stream. By default both attributes are TRUE which will play the streams that exist in the media clip. CLIPWIDTH CLIPHEIGHT These may be set to specify the width and height of the area in which the video clip is to play. When not specified the player defaults these attributes to information found in the clip header. F2X When set TRUE (default) the video clip may be scaled by a factor of two but only if there is room within the WIDTH and HEIGHT that the embed tag specifies in the HTML for the clip. When set FALSE the video clip may never be scaled even if space exists. CLICKCONTROL When set TRUE (default) a video clip may be paused, rewound and played by clicking in the video display area. Left mouse button single click does play/pause, right mouse does rewind. When CLICKCONTROL is set to FALSE, or if the clip only contains audio, then control is via a button bar. WIDTH HEIGHT The WIDTH and HEIGHT attributes specify (in pixels) the size of the window the browser should create to display the media stream and the possible button bar control. When CLICKCONTROL is set to TRUE for a video clip, the WIDTH/HEIGHT attributes should be at least the size of the video image. When set FALSE then 15 pixels are needed to be added to any video clip height (audio only clip will need 15 pixels height for the button bar alone). BK="#RRGGBB" Sets the background color of the plug-in display area to the color specified by the RGB triplet. Each color is given as a hex digit pair. Eg. "#800000' is mid-red and "#FF0000" is bright-red. The color defaults to a pale-gray when BK is not present. AUDIOPORT VIDEOPORT These attributes are used in case of LIVE set TRUE and define the broadcast machines ports for the live streams. AUDIOPORT defaults to 7001 and VIDEOPORT to 7002. As an example a video/audio clip may be displayed in a web page using the following:- Here the video(176x112)/audio clip is displayed along with a control button bar in an area 226x162. The clip cannot be scaled (there is no room anyway in the 226x162 for the 176x112 video to be scaled by 2). The background color "#c0c0c0" is a light-gray. Note that by knowing the default attributes the same result can be achieved using the following:- SRC, WIDTH and HEIGHT are mandatory. Only the optional CLICKCONTROL has been specified and set to FALSE - to enable the button bar control. The following example is for playing a live bamba audio source.