WHAT IT IS ---------- This is Cortado, a multimedia framework for Java written by Fluendo. It contains: - JST, a port of the GStreamer 0.10 design to Java - jcraft, a copy of the JCraft JOgg/Jorbis code - jheora, an implementation of Theora in Java - jkate, an implementation of a basic Kate decoder in Java - jtiger, a basic Kate renderer (simple text/images only for now) - codecs (currently only containing the Smoke codec, a variant on Jpeg) - JST plugins for: - HTTP source element - Ogg and Multipart demuxers - Theora, JPEG and Smoke video decoders - Vorbis and MuLaw audio decoders - Java 1.1 sun.audio API audio sink - Java 1.4 javax.sound.sampled API audio sink - Overlay element - Kate text decoder and overlay - Selector element - examples - applets This release has support for - seeking in on-demand files - the above-mentioned plugins - basic HTTP authentication - buffering FAQ --- For frequently asked questions check our website at http://theora.org/cortado/ If any questions should be added, let us know. BUGS ---- You can file bugs at Xiph's issue tracker: https://trac.xiph.org/newticket?component=Cortado Make sure to choose the "Cortado" component. BUILDING -------- The build uses ant exclusively now. Normally, running ant Should build everything, if your system is setup correctly. You can copy build.config.sample to build.config and tweak it to choose certain settings. Run ant -p to see all the possible targets. EXAMPLES -------- You need a Java Virtual Machine to run the example code. You also need to set the classpath to your build tree when running (output/build/debug or output/build/stripped) - Jikes does not have a VM - gij (the GNU Java VM) does not have a javax.sound.sampled implementation, so fails when playing audio, but can still play video-only files - Sun Java VM works for me: /usr/java/jre1.5.0_04/bin/java -cp output/build/debug com.fluendo.examples.Player http://stream.fluendo.com:8850 (with a JPackage java-1.5.0-sun package) /usr/lib/jvm/java-1.5.0-sun-1.5.0.05/jre/bin/java -cp output/build/debug com.fluendo.examples.Player http://stream.fluendo.com:8850 USAGE ----- Embed the applet in a web page with code like this: ---- ---- parameters: ----------- url: string the URL to load, must be a fully qualified URL. IMPORTANT: if the applet is not signed, the hostname of the url *is required* to be the same as the hostname of the link to the page with the applet tag. This is a Java security limitation. seekable: enum (auto|true|false) Whether or not you can seek in the file. For live streams, this should be false; for on-demand files, this can be true. In automatic mode, the stream becomes seekable when the content length is discovered. Defaults to auto live enum (auto|true|false) Whether or not this file is a live stream. For live streams, this should be true, which will disable the PAUSE button. For on-demand files, this can be false. In automatic mode, the stream becomes non-live when the content length is discovered. Defaults to auto duration: int Length of clip in seconds. Needed when seekable is false, to allow the seek bar to work. startTime: int Start time of clip in seconds. Needed when seekable is false, to allow the seek bar to work. keepAspect: boolean Try to keep the natural aspect of the video when resizing the applet window. true or false. Defaults to true ignoreAspect: boolean Ignore the aspect ratio as signalled by the video, always assume square pixels. true or false. Defaults to false ignoreBasetime: boolean Ignore the ogg file's basetime (initial granule or granpos) when displaying times in the seek bar. Instead, for display purposes, always treat the first sample as occurring at time zero. true or false. Defaults to false video: boolean Use video. When not using video, this property will not create resources to play a video stream. true or false. Defaults to true audio: boolean Use audio. When not using audio, this property will not create resources to play an audio stream. true or false. Defaults to true kateIndex: int Use text from the given Kate stream (indexed from zero). The first Kate stream found will have index 0, the second will have index 1, etc. Selecting a Kate stream by index takes priority over selecting by language and/or category. At most one Kate stream may be enabled at a time. Defaults to -1 (none) kateLanguage: string Use text from the Kate stream with the given language (ISO 639-1 tag). Selecting a Kate stream by index takes priority over selecting by language and/or category. At most one Kate stream may be enabled at a time. Defaults to null (none) kateCategory: string Use text from the Kate stream with the given category. Selecting a Kate stream by index takes priority over selecting by language and/or category. At most one Kate stream may be enabled at a time. Defaults to null (none) statusHeight: int The height of the status area (default 12) autoPlay: boolean Automatically start playback (default true) showStatus: enum (auto|show|hide) Controls how to make the status area visible. auto will show the status area when hovered over with the mouse. hide will only show the status area on error. show will always show the status area. (default auto) showSpeaker: boolean Show a speaker icon when audio is available (default true) showSubtitles: boolean Show a subtitles icon when subtitles are available (default true) hideTimeout: int Timeout in seconds to hide the status area when showStatus is auto. This timeout is to make sure that the status area is visible for the first timeout seconds of playback so that the user can see that there is a clickable status area too. (default 0) bufferSize: int The size of the network buffer, in KB. A good value is max Kbps of the stream * 33 Defaults to 200 bufferLow: int Percentage of low watermark for buffer. Below this, the applet will stop playing and rebuffer until the high watermark is reached. Defaults to 10 bufferHigh: int Percentage of high watermark for buffer. At startup or when rebuffering, the applet will not play until this percentage of buffer fill status is reached. Defaults to 70 userId: string user id for basic authentication. password: string password for basic authentication. debug: int debug level, 0 - 4. Defaults to 3. Output goes to the Java console. Using javascript ---------------- The applet parameters can be changed from javascript by calling the setParam(key, value) on the applet. After setting the new parameters in the applet it needs to be restarted with the restart() method for the changes to take effect. Likewise, applet parameters may be queried using getParam(key, default). The following piece of HTML demonstrates switching URLs with an without sound using javascript: ----

---- The applet can be controlled with the following javascript methods: doPlay(): Start playback doPause(): Pause playback doStop(): Stop playback doSeek(double pos); seek to a new position, must be between 0.0 and 1.0. getPlayPosition(): returns current position in seconds