XiphWiki - User contributions [en]

Summer of Code 2010

2010-03-12T03:13:42Z

Mdale: added initial soc 2010 page

Summer of Code

2010-03-12T03:11:24Z

Mdale: added summer of code 2010

*see [[Summer of Code 2009]]
*see [[Summer of Code 2008]]
*see [[Summer of Code 2010]]

OggIndex-Migration

2010-03-09T19:17:35Z

Mdale: added cortado to the list

This page is for collecting patches related to the [[Ogg Index]] introduction.

Please add links and information about your favorite applications to this page!

Applications which read (decode) Ogg files should be extended to additionally recognize the OggIndex.

=== Encoders ===

* ffmpeg2theora supports creating indexes

* what about other encoders? VLC, GStreamer

* oggz-chop support on output

=== Decoders ===

==== oggz-chop ====

* files with index can be chopped, output will not include an index
* should use index for seeking and include an index in output

==== GStreamer ====

* support missing, opening files in totem it askes to search for a plugin, after that one can press play again and it plays but does not allow you to seek.

* Needs indexing added to the Ogg mux?

==== MPlayer ====

* support missing, no error

==== VLC ====

* support missing, no error

==== Cortado ====

* support missing, not tested

==== XiphQT ====

* support missing, not tested

==== FFMpeg ====

* support missing, not tested

HTML5

2009-07-08T17:52:00Z

Mdale: updaed IE

The HTML5 specification includes support for <video> and <audio>.
This page outlines use of HTML5 syntax with Xiph.Org codecs, particularly Ogg [[Theora]] and Ogg [[Vorbis]]. It is also a place to collect ideas for [http://ogg.org/ ogg.org].

See also the [http://en.flossmanuals.net/theoracookbook Theora Cookbook] for a guide to streaming and working with Ogg Theora.

== Browser Support ==

Our list of [[TheoraSoftwarePlayers]] lists many general-purpose media players that support Ogg Theora.

These web browsers support HTML5 with Ogg video:

=== Mozilla Firefox ===

[http://www.mozilla.com/en-US/firefox/firefox.html Firefox 3.5]
includes "support for the HTML5 <video> and <audio> elements including native support for Ogg Theora encoded video and Vorbis encoded audio." See [https://developer.mozilla.org/en/Using_audio_and_video_in_Firefox Using audio and video in Firefox] at the Mozilla Developer Center for more info.

=== Opera ===

In [http://dev.opera.com/articles/view/a-call-for-video-on-the-web-opera-vid/ A call for video on the web - Opera <video> release on Labs], Opera announce that they "have created an experimental build of our browser for Windows, Mac and Linux with ... support for the <video> element/Ogg Theora built in".

The article contains links to experimental builds of Opera 9.52, and provides some simple examples of HTML5 <video> markup.

=== Google Chrome ===

Unstable builds are available from the
[http://dev.chromium.org/getting-involved/dev-channel dev-channel].
The first version supporting Ogg Theora was chrome 3.0.182.2.

=== Apple Safari ===

Install [[XiphQT]]

=== Microsoft Internet Explorer ===

* The default install of [http://www.videolan.org/vlc/ VLC] includes the activeX extension that enables inline ogg theora playback.
* You can also install the [http://www.xiph.org/dshow/ direct show filters] for windows media player.

=== Plugins ===

[http://itheora.org/?p=screens Compatibility]

== Web Video sites ==

For more examples of Ogg Theora video, see
[[List of Theora videos]].

The following web sites support HTML5 with Ogg Theora.

=== Community upload sites ===

These sites allow anyone to upload video, and provide transcoding
to Ogg:

* [http://www.dailymotion.com DailyMotion]. See also DailyMotion's [http://www.dailymotion.com/openvideodemo Open Video Demo] (restricted to Firefox 3.5)
* Chris Double's [http://tinyvid.tv Tinyvid] (transcoding via Firefogg)

=== Archival and Reference ===

Sites that curate video for general archival and reference purposes,
and allow anyone to upload relevant material:

* [http://www.archive.org/details/movies Archive.org’s videos]
* [http://commons.wikimedia.org/wiki/Category:Videos_by_format Wikipedia’s videos]

=== Projects ===

* [http://metavid.org metavid]: The Open Video archive of the US Congress
* [http://pad.ma pad.ma]: Public Access Digital Media Archive is an online archive of densely text-annotated video material, primarily footage and not finished films.

=== Conferences ===

* [http://mirror.linux.org.au/linux.conf.au/ linux.conf.au]
* DebConf: on the individual conference pages, e.g. [http://wiki.debconf.org/wiki/DebConf8/Streams]
* The [http://www.foms-workshop.org/foms2009/pmwiki.php/Main/Proceedings FOMS workshop videos]: proceedings from a workshop on free and open multimedia software.

== Technology for setting up your own site ==

=== HTML5 <video> embedding ===

There are various ways to provide HTML5 video content with fallbacks for older browsers and non-free codecs.

You can include one of the scripts below, or modify source from an existing page such as the HTML of
[http://www.celt-codec.org/presentations/ CELT presentations].

==== mv_embed ====

[http://metavid.org/w/index.php/Mv_embed Mv_embed] is "a javascript library for easy embedding of ogg theora/vorbis media with the html5 tag. Once the script is included you can include an inline ogg theora clip with:

<video src="mymovie.ogg">

"Mv_embed will then rewrite the video tag to whatever playback method is available on the client be it native support, java cortado, mplayer or vlc".

* [http://www.firefogg.org/make/mwEmbed/example_usage/Player_Simple_Video_Tag.html Demo and sample HTML].

See also [http://www.mediawiki.org/wiki/Media_Projects_Overview#MwEmbed mv_embed on MediaWiki].

==== iTheora ====

[http://itheora.org/ iTheora]

Example sites using iTheora:
* [http://theorasea.org]

==== video4all ====

[http://code.google.com/p/video4all/ video4all at Google Code]

Uses browser specific technology (.htc, .xbl, or plain .js) to rewrite video tags to fall back to H.264 in Flash for legacy browsers, while providing H.264 natively to Safari and Theora for Mozilla. Roughly speaking a script version of Kroc Camen's pure HTML Video For Everybody solution. Doesn't (currently) use any Theora based fallbacks.

==== Video for Everybody ====

[http://camendesign.com/code/video_for_everybody Video for Everybody] is
"a chunk of HTML code that embeds a video into a website
using the HTML5 <video> element."

:*Comment: We really shouldn't be plugging a solution which eschews cortado as a fall back in favor of FLV. A pure HTML triple check video/java/youtube would be better, but no pure HTML solution perform a canplaytype so it will break for safari users without xiphqt. Is "possible to add raw HTML but no JS" a common enough situation that a JS free solution is really needed? --[[User:Gmaxwell|Gmaxwell]] 22:58, 30 June 2009 (PDT)

:*Comment: It's clear that this solution makes a few compromises in order to be JS-free. The code is both fragile and frightening for reasons that make sense with regard to the original author's goals but aren't relevant if e.g. promoting Theora adoption takes precedence over a distaste for Java and/or Javascript. --[[User:Bod|Bod]] 06:03, 6 July 2009 (PDT)

=== HTML5 <audio> embedding ===

There are various ways to provide HTML5 audio content in Vorbis and there are Java and Flash fallbacks for older browsers (and non-free codecs though this is even less necessary than it is in the case of Theora video).

==== Vorbis via Flash 10 ====

[http://barelyfocused.net/blog/2008/10/03/flash-vorbis-player/ fogg (aka FVorbis)], [[Jorbis]] code automatically ported to Haxe and then compiled to AS3

[http://labs.adobe.com/wiki/index.php/Alchemy:Libraries Alchemy Vorbis], Adobe's Alchemy allows compiling C and C++ plus to AS3. Vorbis is one of the demo libraries they ported.

[http://flash.j-ogg.de/10/ flash.j-ogg], haxe and actionscript3 translation of j-ogg

==== Vorbis via Java ====

[http://www.jcraft.com/jorbis/ JorbisPlayer]

[http://www.j-ogg.de/core/main?/index-vorbis.html J-Ogg]

==== Vorbis via Javascript and <audio> tag ====

[http://alpha.libre.fm/listen/?tag=rock web radio interface]

=== Encoding, transcoding ===

==== Firefogg ====

[http://firefogg.org/ Firefogg] provides "video encoding and uploading for Firefox". This includes a Firefox extension that allows users to encode video to Ogg Theora on their own computer while uploading it to your site. This simplifies the upload for users as they can simply choose from their existing video files, and simplifies your web site by allowing you to deal with only one video format, and offloading the CPU cycles required for encoding to the user.

=== Content management ===

* The [http://www.mediawiki.org/wiki/Extension:OggHandler OggHandler extension] for MediaWiki provides video and audio support with automatic fallback and thumbnailing.
* [http://metavid.org/wiki/MetaVidWiki_Software MetaVidWiki]

=== Backend servers ===

* [http://www.xiph.org/oggz/ oggz-chop] allows you to serve time ranges of Ogg media over HTTP by any web server that supports CGI. Examples of such time range requests are http://www.example.com/video.ogv?t=200/600 which serves the segment of video.ogv from 200s-600s. This allows users to instantly jump to any point in a video, and you can put links in your web application to play arbitrary scenes.

HTML5

2009-06-25T23:00:00Z

Mdale: /* Web Video sites */ added links

The HTML5 specification includes support for <video> and <audio>.
This page outlines use of HTML5 syntax with Xiph.Org codecs, particularly Ogg [[Theora]] and Ogg [[Vorbis]]. It is also a place to collect ideas for [http://ogg.org/ ogg.org].

== Browser Support ==

[[TheoraSoftwarePlayers]]

=== Mozilla Firefox ===

=== Opera ===

=== Google Chrome ===

=== Apple Safari ===

=== Microsoft Internet Explorer ===

=== Plugins ===

[http://itheora.org/?p=screens Compatibility]

== Web Video sites ==

The following web sites support HTML5 with ogg theora:

* [http://tinyvid.tv tinyvid.tv]
* [http://www.dailymotion.com DailyMotion]
* [http://metavid.org metavid.org]
* [http://pad.ma pad.ma]

For more examples of Ogg Theora video, see
[[List of Theora videos]].

== Technology for setting up your own site ==

=== HTML5 <video> embedding ===

There are various ways to provide HTML5 video content with fallbacks for older browsers and non-free codecs.

You can include one of the scripts below, or modify source from an existing page such as the HTML of
[http://www.celt-codec.org/presentations/ CELT presentations].

==== mv_embed ====

[http://metavid.org/w/index.php/Mv_embed mv_embed homepage]
and
[http://www.mediawiki.org/wiki/Media_Projects_Overview#MwEmbed mv_embed on MediaWiki]

Example sites using mv_embed:
* [http://www.firefogg.org/make/mwEmbed/example_usage/Player_Simple_Video_Tag.html]

==== iTheora ====

[http://itheora.org/ iTheora]

Example sites using iTheora:
* [http://theorasea.org]

==== Video for Everybody ====

[http://camendesign.com/code/video_for_everybody Video for Everybody] is
"a chunk of HTML code that embeds a video into a website
using the HTML5 <video> element."

=== Encoding, transcoding ===

==== Firefogg ====

[http://firefogg.org/ Firefogg] provides "video encoding and uploading for Firefox". This includes a Firefox extension that allows users to encode video to Ogg Theora on their own computer while uploading it to your site. This simplifies the upload for users as they can simply choose from their existing video files, and simplifies your web site by allowing you to deal with only one video format, and offloading the CPU cycles required for encoding to the user.

=== Content management ===

* The [http://www.mediawiki.org/wiki/Extension:OggHandler OggHandler extension] for MediaWiki provides video and audio support with automatic fallback and thumbnailing.
* [http://metavid.org/wiki/MetaVidWiki_Software MetaVidWiki]

=== Backend servers ===

* [http://www.xiph.org/oggz/ oggz-chop]

Html5

2009-06-25T22:56:22Z

Mdale: added redirect

#REDIRECT [[HTML5]]

Summer of Code 2009

2009-03-12T15:56:55Z

Mdale: added mozilla summer of code link

This is our ideas page for [http://code.google.com/soc/ Google Summer of Code 2009] projects with [http://xiph.org Xiph.org] and [http://annodex.org/ Annodex]. The two projects participate jointly this year under Xiph's name.

'''Students''' please use the template at [[Summer of Code Applications]] when applying for a GSoC position.

'''Mentors''' please visit [[Summer of Code Mentoring]] and help us prepare our application as a mentoring organization.

== General Ideas ==

* Kate to HTML & CSS overlay library in javascript.

* Proof of concept liboggplay-based media patch for Google's Chrome browser.

* mod_duration apache module to generate X-Content-Duration headers for Ogg files. ''(We should get people to use '''oggz_chop''' instead ... oggz_chop provides this functionality and more, is already relatively lightweight.)'' Perhaps this project could be more focused on packaging oggz_chop for other web servers like lightpd and maybe a fastCGI version and or maybe push for an mod_ogg to be adopted upstream in apache to improve distribution.

* Get skeleton patches upstream so players stop choking on it.
* Portable listening application for codec MOS/MUSHRA comparisons (Win32, MacOS, Linux; FF3.1 web application?).
* Conference bridge using CELT.
* Reference SIP client for CELT.
* Firefox extension to record locally and stream to icecast.
* Firefox extension to support RTP for conferencing.
** also consider applying [https://wiki.mozilla.org/Community:SummerOfCode09#Firefox under Mozilla SOC org].
* OpenMAX IL components for Ogg codecs

== Detailed Project Descriptions ==

These ideas were suggested by various members of the developer community as projects that would be beneficial and which we feel we can mentor. Students should feel free to select one of these, develop a variation, or propose their own ideas. Here, ideally.

=== Proof of Concept liboggplay (html5 video) support in Chromium Browser ===

This project would focus on integrating support for liboggplay into chrome. This project would only need to be a proof of concept with the end result being some frames decoded in the browser. We have some direct contacts with people on the Chromium project in Google, but would expect the student mostly to work through the Xiph on Chromium online communities.

[http://code.google.com/chromium/ Chromium Home Page]

=== Metavid related projects ===

see [http://metavid.org/wiki/Summer_of_Code_2009 full page on metavid.org]
* Improve transcript import / export system:
** Wiki to SRT
** SRT to Wiki
** CMML to Wiki
** Extend oggz_chop or other tool for exporting transcript encapsulated in the ogg file.

=== Javascript Library for Subtitles, Captions and other time-aligned text ===

The main focus of the project is around enabling video accessibility for Ogg in Firefox.

Captions, subtitles and other categories of time-aligned text are starting to become relevant to HTML5. In Ogg, we currently encapsulate such data in OggKate and can use SRT or Kate as input formats. Display of OggKate is currently supported in VLC and there are patches for various other media players. We now want to enable Web browsers to also deal with these time-aligned text tracks in those Web Browsers that support the HTML5 video tag.

There is a proof of concept patch for Firefox 3.1 (now called 3.5) and liboggplay through which Firefox is capable of decoding Ogg Kate tracks and either overlay them onto the video, or handing the raw text to the browser (eg, for text to speech). However, there is no display of OggKate in Firefox 3.5 using HTML5. This can be fixed through the creation of a javascript library that can deal with Kate output and convert it to HTML and CSS. Example libraries exists for displaying SRT for HTML5 video, but they will need to be extended to Kate in this project.

This project includes the creation of example files for different types of time-aligned text. These are then encapsulated into Ogg through Kate encoding. Firefox 3.5 with the applied OggKate patch can decode these files and hand the textual data to the Web browser. It will be necessary to extend liboggplay to pass non textual Kate data (eg, styling, etc) to the browser, as currently the only two ways of dealing with a Kate track is to render it, or pass raw text, ignoring extra styling information. This could be part of the project, or done before the GSoC projects begins. The browser receives the text and styling information, and a javascript library implemented by the student will take care of the display. This will include an implementation of default display mechanisms for the different types of time-aligned text that we decide to deal with.

The project requires a student with experience in javascript development, HTML and CSS, but also with some understanding of C for liboggplay and libkate, and of C++ for Firefox. The student will learn how to deal with Ogg and Ogg tracks, including Ogg Kate. He/she will also get some insight into Firefox development. He/she will work with the developer of Ogg Kate and the video accessibility expert of Xiph, as well as having access to the whole Xiph community including the core developer of Ogg support in Firefox.

The project is adaptable to the qualifications of the student - it may consist in simply implementing a tool-chain for handling srt through OggKate, or it may go much further and include richer forms or time-aligned text such as audio annotations, Karaoke, ticker text, clickable text etc.

=== OpenMAX IL components for Ogg codecs ===

OpenMAX is a set of low-level C APIs for media codecs. It is used by many mobile devices, in platforms like [http://www.maemo.org/ Maemo] and [http://source.android.com/ Android]. As we'd like to encourage the use of free codecs on mobile and embedded devices, we want to develop a set of components using our codec libraries.

For details, including the motivation for this project and links to related projects, see
[http://blog.kfish.org/2009/02/is-openmax-important-for-free-software.html Is OpenMAX important for Free Software?]

==See Also==
*[[Summer of Code 2008]]
*[[Summer of Code 2007]]
*[[Summer of Code 2006]]

Summer of Code 2009

2009-03-12T15:53:49Z

Mdale: /* General Ideas */ mod duration info

This is our ideas page for [http://code.google.com/soc/ Google Summer of Code 2009] projects with [http://xiph.org Xiph.org] and [http://annodex.org/ Annodex]. The two projects participate jointly this year under Xiph's name.

'''Students''' please use the template at [[Summer of Code Applications]] when applying for a GSoC position.

'''Mentors''' please visit [[Summer of Code Mentoring]] and help us prepare our application as a mentoring organization.

== General Ideas ==

* Kate to HTML & CSS overlay library in javascript.

* Proof of concept liboggplay-based media patch for Google's Chrome browser.

* mod_duration apache module to generate X-Content-Duration headers for Ogg files. ''(We should get people to use '''oggz_chop''' instead ... oggz_chop provides this functionality and more, is already relatively lightweight.)'' Perhaps this project could be more focused on packaging oggz_chop for other web servers like lightpd and maybe a fastCGI version and or maybe push for an mod_ogg to be adopted upstream in apache to improve distribution.

* Get skeleton patches upstream so players stop choking on it.
* Portable listening application for codec MOS/MUSHRA comparisons (Win32, MacOS, Linux; FF3.1 web application?).
* Conference bridge using CELT.
* Reference SIP client for CELT.
* Firefox extension to record locally and stream to icecast.
* Firefox extension to support RTP for conferencing.
* OpenMAX IL components for Ogg codecs

== Detailed Project Descriptions ==

These ideas were suggested by various members of the developer community as projects that would be beneficial and which we feel we can mentor. Students should feel free to select one of these, develop a variation, or propose their own ideas. Here, ideally.

=== Proof of Concept liboggplay (html5 video) support in Chromium Browser ===

This project would focus on integrating support for liboggplay into chrome. This project would only need to be a proof of concept with the end result being some frames decoded in the browser. We have some direct contacts with people on the Chromium project in Google, but would expect the student mostly to work through the Xiph on Chromium online communities.

[http://code.google.com/chromium/ Chromium Home Page]

=== Metavid related projects ===

see [http://metavid.org/wiki/Summer_of_Code_2009 full page on metavid.org]
* Improve transcript import / export system:
** Wiki to SRT
** SRT to Wiki
** CMML to Wiki
** Extend oggz_chop or other tool for exporting transcript encapsulated in the ogg file.

=== Javascript Library for Subtitles, Captions and other time-aligned text ===

The main focus of the project is around enabling video accessibility for Ogg in Firefox.

Captions, subtitles and other categories of time-aligned text are starting to become relevant to HTML5. In Ogg, we currently encapsulate such data in OggKate and can use SRT or Kate as input formats. Display of OggKate is currently supported in VLC and there are patches for various other media players. We now want to enable Web browsers to also deal with these time-aligned text tracks in those Web Browsers that support the HTML5 video tag.

There is a proof of concept patch for Firefox 3.1 (now called 3.5) and liboggplay through which Firefox is capable of decoding Ogg Kate tracks and either overlay them onto the video, or handing the raw text to the browser (eg, for text to speech). However, there is no display of OggKate in Firefox 3.5 using HTML5. This can be fixed through the creation of a javascript library that can deal with Kate output and convert it to HTML and CSS. Example libraries exists for displaying SRT for HTML5 video, but they will need to be extended to Kate in this project.

This project includes the creation of example files for different types of time-aligned text. These are then encapsulated into Ogg through Kate encoding. Firefox 3.5 with the applied OggKate patch can decode these files and hand the textual data to the Web browser. It will be necessary to extend liboggplay to pass non textual Kate data (eg, styling, etc) to the browser, as currently the only two ways of dealing with a Kate track is to render it, or pass raw text, ignoring extra styling information. This could be part of the project, or done before the GSoC projects begins. The browser receives the text and styling information, and a javascript library implemented by the student will take care of the display. This will include an implementation of default display mechanisms for the different types of time-aligned text that we decide to deal with.

The project requires a student with experience in javascript development, HTML and CSS, but also with some understanding of C for liboggplay and libkate, and of C++ for Firefox. The student will learn how to deal with Ogg and Ogg tracks, including Ogg Kate. He/she will also get some insight into Firefox development. He/she will work with the developer of Ogg Kate and the video accessibility expert of Xiph, as well as having access to the whole Xiph community including the core developer of Ogg support in Firefox.

The project is adaptable to the qualifications of the student - it may consist in simply implementing a tool-chain for handling srt through OggKate, or it may go much further and include richer forms or time-aligned text such as audio annotations, Karaoke, ticker text, clickable text etc.

=== OpenMAX IL components for Ogg codecs ===

OpenMAX is a set of low-level C APIs for media codecs. It is used by many mobile devices, in platforms like [http://www.maemo.org/ Maemo] and [http://source.android.com/ Android]. As we'd like to encourage the use of free codecs on mobile and embedded devices, we want to develop a set of components using our codec libraries.

For details, including the motivation for this project and links to related projects, see
[http://blog.kfish.org/2009/02/is-openmax-important-for-free-software.html Is OpenMAX important for Free Software?]

==See Also==
*[[Summer of Code 2008]]
*[[Summer of Code 2007]]
*[[Summer of Code 2006]]

Summer of Code 2009

2009-03-12T15:52:24Z

Mdale: /* General Ideas */ mod duration info

This is our ideas page for [http://code.google.com/soc/ Google Summer of Code 2009] projects with [http://xiph.org Xiph.org] and [http://annodex.org/ Annodex]. The two projects participate jointly this year under Xiph's name.

'''Students''' please use the template at [[Summer of Code Applications]] when applying for a GSoC position.

'''Mentors''' please visit [[Summer of Code Mentoring]] and help us prepare our application as a mentoring organization.

== General Ideas ==

* Kate to HTML & CSS overlay library in javascript.

* Proof of concept liboggplay-based media patch for Google's Chrome browser.

* mod_duration apache module to generate X-Content-Duration headers for Ogg files. ''(We should get people to use '''oggz_chop''' instead ... oggz_chop provides this functionality and more, is already relatively lightweight.)'' Perhaps this project could be more focused on packaging oggz_chop for other servers web servers like lightpd and maybe a fastCGI version.

* Get skeleton patches upstream so players stop choking on it.
* Portable listening application for codec MOS/MUSHRA comparisons (Win32, MacOS, Linux; FF3.1 web application?).
* Conference bridge using CELT.
* Reference SIP client for CELT.
* Firefox extension to record locally and stream to icecast.
* Firefox extension to support RTP for conferencing.
* OpenMAX IL components for Ogg codecs

== Detailed Project Descriptions ==

These ideas were suggested by various members of the developer community as projects that would be beneficial and which we feel we can mentor. Students should feel free to select one of these, develop a variation, or propose their own ideas. Here, ideally.

=== Proof of Concept liboggplay (html5 video) support in Chromium Browser ===

This project would focus on integrating support for liboggplay into chrome. This project would only need to be a proof of concept with the end result being some frames decoded in the browser. We have some direct contacts with people on the Chromium project in Google, but would expect the student mostly to work through the Xiph on Chromium online communities.

[http://code.google.com/chromium/ Chromium Home Page]

=== Metavid related projects ===

see [http://metavid.org/wiki/Summer_of_Code_2009 full page on metavid.org]
* Improve transcript import / export system:
** Wiki to SRT
** SRT to Wiki
** CMML to Wiki
** Extend oggz_chop or other tool for exporting transcript encapsulated in the ogg file.

=== Javascript Library for Subtitles, Captions and other time-aligned text ===

The main focus of the project is around enabling video accessibility for Ogg in Firefox.

Captions, subtitles and other categories of time-aligned text are starting to become relevant to HTML5. In Ogg, we currently encapsulate such data in OggKate and can use SRT or Kate as input formats. Display of OggKate is currently supported in VLC and there are patches for various other media players. We now want to enable Web browsers to also deal with these time-aligned text tracks in those Web Browsers that support the HTML5 video tag.

There is a proof of concept patch for Firefox 3.1 (now called 3.5) and liboggplay through which Firefox is capable of decoding Ogg Kate tracks and either overlay them onto the video, or handing the raw text to the browser (eg, for text to speech). However, there is no display of OggKate in Firefox 3.5 using HTML5. This can be fixed through the creation of a javascript library that can deal with Kate output and convert it to HTML and CSS. Example libraries exists for displaying SRT for HTML5 video, but they will need to be extended to Kate in this project.

This project includes the creation of example files for different types of time-aligned text. These are then encapsulated into Ogg through Kate encoding. Firefox 3.5 with the applied OggKate patch can decode these files and hand the textual data to the Web browser. It will be necessary to extend liboggplay to pass non textual Kate data (eg, styling, etc) to the browser, as currently the only two ways of dealing with a Kate track is to render it, or pass raw text, ignoring extra styling information. This could be part of the project, or done before the GSoC projects begins. The browser receives the text and styling information, and a javascript library implemented by the student will take care of the display. This will include an implementation of default display mechanisms for the different types of time-aligned text that we decide to deal with.

The project requires a student with experience in javascript development, HTML and CSS, but also with some understanding of C for liboggplay and libkate, and of C++ for Firefox. The student will learn how to deal with Ogg and Ogg tracks, including Ogg Kate. He/she will also get some insight into Firefox development. He/she will work with the developer of Ogg Kate and the video accessibility expert of Xiph, as well as having access to the whole Xiph community including the core developer of Ogg support in Firefox.

The project is adaptable to the qualifications of the student - it may consist in simply implementing a tool-chain for handling srt through OggKate, or it may go much further and include richer forms or time-aligned text such as audio annotations, Karaoke, ticker text, clickable text etc.

=== OpenMAX IL components for Ogg codecs ===

OpenMAX is a set of low-level C APIs for media codecs. It is used by many mobile devices, in platforms like [http://www.maemo.org/ Maemo] and [http://source.android.com/ Android]. As we'd like to encourage the use of free codecs on mobile and embedded devices, we want to develop a set of components using our codec libraries.

For details, including the motivation for this project and links to related projects, see
[http://blog.kfish.org/2009/02/is-openmax-important-for-free-software.html Is OpenMAX important for Free Software?]

==See Also==
*[[Summer of Code 2008]]
*[[Summer of Code 2007]]
*[[Summer of Code 2006]]

Summer of Code Applications

2009-03-10T22:32:35Z

Mdale: /* Applying for a Google Summer of Code project with Xiph.Org */ applicants

== Applying for a Google Summer of Code project with Xiph.Org ==

Prospective students: please fill out a copy of this template for your application, answering each question in plenty of detail. The more information the better - though we might ask you later for more details anyway.

Our list of suggested projects is at http://wiki.xiph.org/index.php/Summer_of_Code. You're welcome to suggest other projects, though, if you think you have a good idea. Feel free to jump on irc (irc.freenode.net, #xiph) if you'd like to discuss things before submitting a project proposal.

To be accepted, you '''must''' join the project at least peripherally ahead of time. Checking out the code, compiling and submitting sample code are highly recommended bug fixes even better :) Join the [http://lists.xiph.org/mailman/listinfo/ mailing list] for the component you want to work on and introduce yourself. Hang out with us on IRC. Give us a chance to get to know you. Don't be shy. Multimedia programming is technically demanding and while we do everything we can to help our students, we need to understand what your background is, what you know and what we'll need to work on before we can properly evaluate your application.

To reiterate: '''The absolute best thing you can do is to pick a small project or bug and contribute some code. That will give you and us an idea what it's like to work together.'''

= Name and Contact details =

Your name and email address here. IRC nick if you have a regular one.

= Your background =

You're a student! Tell us about what you're studying, where, and so on. Tell us what your interests are, what (if any) work you've previously done in the field of multimedia, and so on.

If you've worked on free software before, that's great. Tell us what you've worked on, what you've done for those projects, etc.

= Project =

What project would you like to work on? If it's one from our list of suggestions, don't just copy the title from there - tell us a bit about what approach(es) you'd like to take to this project. If it's not from that list, tell us as much as you can about what you want to do.

= Project outcomes =

Go into more details here: what do you think you'll be able to get done in the three months available? Name specific goals: features, percentage performance improvements, etc.

= Schedule =

Give us a rough outline of how you want to schedule your work over the three months. If you're going to be away for any part of that, let us know now - it's not a problem if you're heading off on holidays for a week or two, but we have to be convinced you're going to put enough time in. When will you start? What milestones do you want within the project? How much time will you be able to put in? Is this the only thing you'll be doing during the term or do you have other commitments?

= Why should we select you? =

Google's Summer of Code project is enormously popular - unfortunately, we'll have to reject many more proposals than we'll be able to accept. So this is your chance to tell us what makes YOU the best person for us to pick.

Summer of Code Mentoring

2009-03-10T21:53:08Z

Mdale: /* Why is your organization applying to participate in GSoC 2008? What do you hope to gain by participating? */

== Xiph.Org Application as a mentoring organization ==

We need to apply for consideration as a mentoring organization 2008 March 3-12. Google lists the following questions in their [http://code.google.com/soc/2008/faqs.html#0.1_org_apply faq]. Our work-in-progress answers are inline.

==== Describe your organization. ====

The Xiph.Org Foundation is a 501(c)(3) non-profit organization dedicated to providing open and free-to-implement multimedia technology as a foundation for an interoperable, level playing field on the Internet and other digital distribution networks. Over the past 8 years we have developed most of the major patent-free and royalty-free audio and video codecs currently in use, including Vorbis, Speex, FLAC and Theora, as well as developing the Ogg streaming format, and the Icecast streaming media server. Xiph hosted libraries like liboggplay and liboggz power the underling html5 video support in Mozilla Firefox.

This year we are also coordinating projects for the Annodex association under our umbrella. The Annodex projects develop standards and software for timed metadata and temporal media reference compatible with the existing web ecosystem. The Annodex streaming media server is used on sites such as wikipedia and archive.org to facilitate improved video seeking, inter-archive interoperability, and temporal media referencing via URLs

==== Why is your organization applying to participate in GSoC 2008? What do you hope to gain by participating? ====

We believe that the Xiph.Org Foundation has a wide-ranging set of projects that are both challenging and educational for students. Furthermore, they are important/useful goals for the wider technology community, and especially users of open source software.

We believe that Xiph's mandate to develop multimedia standards and software is an important one, but as a small non-profit with no official staff we—of course—have limited resources. We hope that the results of GSoC will include the direct benefit of new software development, but also help grow the number of active participants in a long-term manner. Most of our core developers started as students, but have since moved on from their student days. Attracting and retaining students is essential to the health and sustainability of our project and is an important goal for all of us.

==== Did your organization participate in past GSoCs? If so, please summarize your involvement and the successes and challenges of your participation. ====

The Xiph.Org Foundation was invited to participate in GSoc in both 2006 and 2007, and informally mentored Annodex-related projects as well.

In 2006, we were granted funding for 6 slots. One we weren't able to fill because our chosen students picked or were assigned to other projects.

Two were [http://code.google.com/soc/xiph/about.html successful]. One, a [http://code.google.com/soc/xiph/appinfo.html?csaid=5F9265EEC6FA0611 hardware implementation of a Theora decoder]: this project produced HDL implementation of the major decoder components, to be used with a general purpose CPU, such as the open source LEON sparc implementation. Real time playback of SD content was demonstrated using these components in combination with the proprietary Nagios CPU design. Two, [http://code.google.com/soc/xiph/appinfo.html?csaid=213E2D30F095565D implementation of OggSkeleton support] in various tools. We have maintained contact with the two successful students since the program finished. One has continued to contribute code outside the GSoC term, continuing related work.

The remaining three were unsuccessful through lack of necessary skills, health complications, insufficient motivation, or some combination of all of these.

In 2007, we were given 2 project slots. One was an extension of the hardware decoder effort from last year. The other was helping to do R&D on Xiph's next-generation audio codec, Ghost. Both were marginally successful — the students reached the minimum goals set, but little more, and did not maintain contact with Xiph after the program.

We enjoyed our participation over the last two years. It provided needed external input, energizing our project and improving our connections to the rest of the open source community. We think we've learnt a lot about how to mentor new and upcoming contributors, and how to best screen the applications we do receive.

==== If your organization has not previously participated in GSoC, have you applied in the past? If so, for what year(s)? ====

We have participated previously, in 2006 and 2007.

==== Who will your organization administrator be? Please include Google Account information. ====

Michael Smith has volunteered to be the primary admin this year. Google account mlrsmith@gmail.com.

==== What license(s) does your project use? ====

In general, we use the revised 3-clause BSD license for our libraries, to enable the widest possible uses of our formats and reference implementations.

Our applications are generally GPL but LGPL or (GPL-compatible) modified. BSD is also acceptable.

==== What is the URL for your ideas page? ====

http://wiki.xiph.org/index.php/Summer_of_Code

==== What is the main development mailing list or forum for your organization? ====

We don't have a single central mailing list for all of the Foundation. Instead, we have project-specific mailing lists; of these the most active is vorbis-dev@xiph.org. A complete listing of our lists is available at:

http://lists.xiph.org/mailman/listinfo/

The primary contact of the Annodex projects is [http://lists.annodex.net/ annodex-dev@lists.annodex.net]

==== What is the main IRC channel for your organization? ====

Our main channel is #xiph on irc.freenode.net. We also have project-specific channels: #vorbis, #theora, #icecast, #speex and #annodex are the major ones.

==== Does your organization have an application template you would like to see students use? If so, please provide it now. ====

http://wiki.xiph.org/index.php/Summer_of_Code_Applications

==== Who will be your backup organization administrator? Please include Google Account information. ====

Ralph Giles will be the backup admin if no one else volunteers. Google account giles@xiph.org.

==== Who will your mentors be? Please include Google Account information. ====

* '''Michael Smith''': google account mlrsmith@gmail.com
* '''Ralph Giles''': google account giles@xiph.org
* '''Silvia Pfeiffer''': google account silviapfeiffer1@gmail.com
* '''Christopher Montgomery''': google account xiphmont@gmail.com
* '''Timothy Terriberry''': google account tterribe@vt.edu
* '''Jean-Marc Valin''': google account jmvalin@gmail.com
* '''Arek Korbik''': google account arkadini@gmail.com
* '''Michael Dale''': google account bigmammoth@gmail.com
* '''Ivo Emanuel Gonçalves''': google account justivo@gmail.com

==== What criteria did you use to select these individuals as mentors? Please be as specific as possible. ====

We selected our mentors from the 'core' developers and contributors within Xiph. Mentors were selected based on how well they know the code area they're volunteering to mentor, how long they've been part of Xiph, how well they interact with others (particularly in terms of building community around our projects).

The majority of the mentors we've selected are core developers on the various Xiph sub-projects that they've volunteered to mentor for. They have been contributing to the Xiph.Org Foundation for at least several years, and have shown a persistent interest both in the software we develop, and in helping to create a community around it. We have also made sure that each mentor has sufficient time available to adequately mentor their student(s).

Michael Smith has been involved with the Xiph.Org Foundation and multimedia development since 2000 and remains one of our most involved core members. He helped write major portions of the vorbis-tools suite and the icecast streaming media server. He currently works as a developer at Fluendo.com on the GStreamer multimedia framework, flumotion (a streaming media server), and other multimedia software.

Ralph Giles has been involved with the Xiph.Org Foundation and multimedia development since 2000. He has contributed to tool development and the Theora video codec. He handles much of the coordination and administrative work for the Xiph.Org Foundation. He mentored the successful "Hardware implementation of Theora decoding" project in GSoC 2006 and acted as an administrator.

Silvia Pfeiffer is the founder of the Annodex project and president of the Annodex Association. She is the principle author of most of the Annodex specifications, RFC 3533 describing the Ogg media format, and is heavily involved as an organizer in both the Xiph and Annodex projects. Most recently she organized the [http://www.annodex.org/events/foms2007/ FOMS] developer summit and media recording for [http://lca2007.linux.org.au/ LCA 2007]. She helped mentor the successful "OggSkeleton support" project in GSoC 2006 and acted as an administrator during the application process.

Christopher "Monty" Montgomery is the founder of the Xiph.Org Foundation, architect and lead developer of the Ogg Vorbis general purpose audio compression format. He has been doing open source development under the Xiph name since 1999. His current work focuses on development of a next-generation audio codec and a new Theora encoder. He helped mentor a project related to this in GSoC 2006.

Timothy Terriberry is the author of the Theora video codec specification and the author of the theora-exp implementation. He has been an active contributor since 2003. He mentored a Theora-related project in GSoC 2006.

Jean-Marc Valin is the architect and lead developer of the Speex voice codec. He has been involved in the Xiph.Org Founation since 2002. He mentored an audio codec research project in GSoC 2006.

Arek Korbik is the author of the [http://xiph.org/quicktime/ Xiph QuickTime Components]. He has been a project contributor since 2005.

Michael Dale is the author of the [http://metavid.org MetaVidWiki] project which implements many of the Annodex and Xiph technologies as an extension to MediaWiki.

==== What is your plan for dealing with disappearing students? ====

Our first goal will be to provide necessary support from the community such that our students do not want to suddenly vanish. We want our students to become real members of the community, with ongoing contributions. That said, we're well aware of the possibility of a student disappearing.

We intend to be reasonably strict with requiring students to keep in touch - whilst we're quite happy for them to be absent for a while if they let us know in advance, we will intend to get at least twice-weekly updates from each student.

The mentors will have primary responsibility for their students, but the admins (Mike Smith and Ralph Giles) are also going to ensure that the mentors are indeed keeping track of what their students are up to. We'll ask our students to provide means for us to get in touch beyond email, where possible - phone, etc - in case we need to get in touch urgently.

==== What is your plan for dealing with disappearing mentors? ====

Our mentors are all people who are major contributors to the Xiph projects - and have generally been contributing for many years. So, we think it's pretty unlikely that a mentor will disappear. However, we do have more mentors available than we expect to eventually have students (based on past years), so we're well able to take up the slack if a mentor becomes unavailable for any reason.

Our admins will ensure that the mentors are keeping up with the students appropriately, and should it be absolutely necessary, we will either find another appropriate mentor, or the admins (Michael and Ralph) will take over mentoring the students directly.

==== What steps will you take to encourage students to interact with your project's community before, during and after the program? ====

The Xiph.Org Founation conducts much of its development discussion and community-building on our IRC channels. We'll ask that the students be present there while they're working, where adequate network access makes that possible. We hope to make them feel that they're an important part of our community; that their contributions are really making a difference towards the goals of Xiph.

We intend to be open to their contributions - whilst we're aware that initially their work may not be of a quality sufficient to go into our core codebase immediately, we'll give them write access to our repository to work on a branch. We'll ask them to be open in discussing and designing their contributions on IRC and our mailing lists. Our application template welcomes them to come and ask us questions when they're trying to write up their application. We hope that some, or even all, of the students will continue to be part of the Xiph community after SoC concludes. For those students who have not previously contributed to open source software, we'll teach them about how important community building is for the ongoing health of such projects.

==== What will you do to ensure that your accepted students stick with the project after GSoC concludes? ====

We hope that the mentoring process and the experiences they have as part of GSoC will make the students interested in remaining part of Xiph, continuing development on the software they've been working on, and perhaps nurturing their patches towards inclusion in an actual release.

A very important part of GSoC is for us to make them active members of the community, in particular on the irc channels and the mailing lists. Past experience tells that once they have become part of that community, they will stick around for longer.

We will encourage them not to consider this just "a summer job", but as being part of a real community — and doing something that is both interesting, and useful to the wider world.

Summer of Code Mentoring

2009-03-10T21:50:41Z

Mdale: /* Describe your organization. */ updaed per draft

== Xiph.Org Application as a mentoring organization ==

We need to apply for consideration as a mentoring organization 2008 March 3-12. Google lists the following questions in their [http://code.google.com/soc/2008/faqs.html#0.1_org_apply faq]. Our work-in-progress answers are inline.

==== Describe your organization. ====

The Xiph.Org Foundation is a 501(c)(3) non-profit organization dedicated to providing open and free-to-implement multimedia technology as a foundation for an interoperable, level playing field on the Internet and other digital distribution networks. Over the past 8 years we have developed most of the major patent-free and royalty-free audio and video codecs currently in use, including Vorbis, Speex, FLAC and Theora, as well as developing the Ogg streaming format, and the Icecast streaming media server. Xiph hosted libraries like liboggplay and liboggz power the underling html5 video support in Mozilla Firefox.

This year we are also coordinating projects for the Annodex association under our umbrella. The Annodex projects develop standards and software for timed metadata and temporal media reference compatible with the existing web ecosystem. The Annodex streaming media server is used on sites such as wikipedia and archive.org to facilitate improved video seeking, inter-archive interoperability, and temporal media referencing via URLs

==== Why is your organization applying to participate in GSoC 2008? What do you hope to gain by participating? ====

We believe that the Xiph.Org Foundation has a wide-ranging set of projects that are both challenging and educational for students. Furthermore, they are important/useful goals for the wider technology community, and especially users of open source software.

We believe that Xiph's mandate to develop multimedia standards and software is an important one, but we—of course—have limited resources. We hope that the results of GSoC will include the direct benefit of new software development, but also help grow the number of active participants in a long-term manner. Most of our core developers started as students, but have since moved on from their student days. Attracting and retaining students is essential to the health and sustainability of our project and is an important goal for all of us.

==== Did your organization participate in past GSoCs? If so, please summarize your involvement and the successes and challenges of your participation. ====

The Xiph.Org Foundation was invited to participate in GSoc in both 2006 and 2007, and informally mentored Annodex-related projects as well.

In 2006, we were granted funding for 6 slots. One we weren't able to fill because our chosen students picked or were assigned to other projects.

Two were [http://code.google.com/soc/xiph/about.html successful]. One, a [http://code.google.com/soc/xiph/appinfo.html?csaid=5F9265EEC6FA0611 hardware implementation of a Theora decoder]: this project produced HDL implementation of the major decoder components, to be used with a general purpose CPU, such as the open source LEON sparc implementation. Real time playback of SD content was demonstrated using these components in combination with the proprietary Nagios CPU design. Two, [http://code.google.com/soc/xiph/appinfo.html?csaid=213E2D30F095565D implementation of OggSkeleton support] in various tools. We have maintained contact with the two successful students since the program finished. One has continued to contribute code outside the GSoC term, continuing related work.

The remaining three were unsuccessful through lack of necessary skills, health complications, insufficient motivation, or some combination of all of these.

In 2007, we were given 2 project slots. One was an extension of the hardware decoder effort from last year. The other was helping to do R&D on Xiph's next-generation audio codec, Ghost. Both were marginally successful — the students reached the minimum goals set, but little more, and did not maintain contact with Xiph after the program.

We enjoyed our participation over the last two years. It provided needed external input, energizing our project and improving our connections to the rest of the open source community. We think we've learnt a lot about how to mentor new and upcoming contributors, and how to best screen the applications we do receive.

==== If your organization has not previously participated in GSoC, have you applied in the past? If so, for what year(s)? ====

We have participated previously, in 2006 and 2007.

==== Who will your organization administrator be? Please include Google Account information. ====

Michael Smith has volunteered to be the primary admin this year. Google account mlrsmith@gmail.com.

==== What license(s) does your project use? ====

In general, we use the revised 3-clause BSD license for our libraries, to enable the widest possible uses of our formats and reference implementations.

Our applications are generally GPL but LGPL or (GPL-compatible) modified. BSD is also acceptable.

==== What is the URL for your ideas page? ====

http://wiki.xiph.org/index.php/Summer_of_Code

==== What is the main development mailing list or forum for your organization? ====

We don't have a single central mailing list for all of the Foundation. Instead, we have project-specific mailing lists; of these the most active is vorbis-dev@xiph.org. A complete listing of our lists is available at:

http://lists.xiph.org/mailman/listinfo/

The primary contact of the Annodex projects is [http://lists.annodex.net/ annodex-dev@lists.annodex.net]

==== What is the main IRC channel for your organization? ====

Our main channel is #xiph on irc.freenode.net. We also have project-specific channels: #vorbis, #theora, #icecast, #speex and #annodex are the major ones.

==== Does your organization have an application template you would like to see students use? If so, please provide it now. ====

http://wiki.xiph.org/index.php/Summer_of_Code_Applications

==== Who will be your backup organization administrator? Please include Google Account information. ====

Ralph Giles will be the backup admin if no one else volunteers. Google account giles@xiph.org.

==== Who will your mentors be? Please include Google Account information. ====

* '''Michael Smith''': google account mlrsmith@gmail.com
* '''Ralph Giles''': google account giles@xiph.org
* '''Silvia Pfeiffer''': google account silviapfeiffer1@gmail.com
* '''Christopher Montgomery''': google account xiphmont@gmail.com
* '''Timothy Terriberry''': google account tterribe@vt.edu
* '''Jean-Marc Valin''': google account jmvalin@gmail.com
* '''Arek Korbik''': google account arkadini@gmail.com
* '''Michael Dale''': google account bigmammoth@gmail.com
* '''Ivo Emanuel Gonçalves''': google account justivo@gmail.com

==== What criteria did you use to select these individuals as mentors? Please be as specific as possible. ====

We selected our mentors from the 'core' developers and contributors within Xiph. Mentors were selected based on how well they know the code area they're volunteering to mentor, how long they've been part of Xiph, how well they interact with others (particularly in terms of building community around our projects).

The majority of the mentors we've selected are core developers on the various Xiph sub-projects that they've volunteered to mentor for. They have been contributing to the Xiph.Org Foundation for at least several years, and have shown a persistent interest both in the software we develop, and in helping to create a community around it. We have also made sure that each mentor has sufficient time available to adequately mentor their student(s).

Michael Smith has been involved with the Xiph.Org Foundation and multimedia development since 2000 and remains one of our most involved core members. He helped write major portions of the vorbis-tools suite and the icecast streaming media server. He currently works as a developer at Fluendo.com on the GStreamer multimedia framework, flumotion (a streaming media server), and other multimedia software.

Ralph Giles has been involved with the Xiph.Org Foundation and multimedia development since 2000. He has contributed to tool development and the Theora video codec. He handles much of the coordination and administrative work for the Xiph.Org Foundation. He mentored the successful "Hardware implementation of Theora decoding" project in GSoC 2006 and acted as an administrator.

Silvia Pfeiffer is the founder of the Annodex project and president of the Annodex Association. She is the principle author of most of the Annodex specifications, RFC 3533 describing the Ogg media format, and is heavily involved as an organizer in both the Xiph and Annodex projects. Most recently she organized the [http://www.annodex.org/events/foms2007/ FOMS] developer summit and media recording for [http://lca2007.linux.org.au/ LCA 2007]. She helped mentor the successful "OggSkeleton support" project in GSoC 2006 and acted as an administrator during the application process.

Christopher "Monty" Montgomery is the founder of the Xiph.Org Foundation, architect and lead developer of the Ogg Vorbis general purpose audio compression format. He has been doing open source development under the Xiph name since 1999. His current work focuses on development of a next-generation audio codec and a new Theora encoder. He helped mentor a project related to this in GSoC 2006.

Timothy Terriberry is the author of the Theora video codec specification and the author of the theora-exp implementation. He has been an active contributor since 2003. He mentored a Theora-related project in GSoC 2006.

Jean-Marc Valin is the architect and lead developer of the Speex voice codec. He has been involved in the Xiph.Org Founation since 2002. He mentored an audio codec research project in GSoC 2006.

Arek Korbik is the author of the [http://xiph.org/quicktime/ Xiph QuickTime Components]. He has been a project contributor since 2005.

Michael Dale is the author of the [http://metavid.org MetaVidWiki] project which implements many of the Annodex and Xiph technologies as an extension to MediaWiki.

==== What is your plan for dealing with disappearing students? ====

Our first goal will be to provide necessary support from the community such that our students do not want to suddenly vanish. We want our students to become real members of the community, with ongoing contributions. That said, we're well aware of the possibility of a student disappearing.

We intend to be reasonably strict with requiring students to keep in touch - whilst we're quite happy for them to be absent for a while if they let us know in advance, we will intend to get at least twice-weekly updates from each student.

The mentors will have primary responsibility for their students, but the admins (Mike Smith and Ralph Giles) are also going to ensure that the mentors are indeed keeping track of what their students are up to. We'll ask our students to provide means for us to get in touch beyond email, where possible - phone, etc - in case we need to get in touch urgently.

==== What is your plan for dealing with disappearing mentors? ====

Our mentors are all people who are major contributors to the Xiph projects - and have generally been contributing for many years. So, we think it's pretty unlikely that a mentor will disappear. However, we do have more mentors available than we expect to eventually have students (based on past years), so we're well able to take up the slack if a mentor becomes unavailable for any reason.

Our admins will ensure that the mentors are keeping up with the students appropriately, and should it be absolutely necessary, we will either find another appropriate mentor, or the admins (Michael and Ralph) will take over mentoring the students directly.

==== What steps will you take to encourage students to interact with your project's community before, during and after the program? ====

The Xiph.Org Founation conducts much of its development discussion and community-building on our IRC channels. We'll ask that the students be present there while they're working, where adequate network access makes that possible. We hope to make them feel that they're an important part of our community; that their contributions are really making a difference towards the goals of Xiph.

We intend to be open to their contributions - whilst we're aware that initially their work may not be of a quality sufficient to go into our core codebase immediately, we'll give them write access to our repository to work on a branch. We'll ask them to be open in discussing and designing their contributions on IRC and our mailing lists. Our application template welcomes them to come and ask us questions when they're trying to write up their application. We hope that some, or even all, of the students will continue to be part of the Xiph community after SoC concludes. For those students who have not previously contributed to open source software, we'll teach them about how important community building is for the ongoing health of such projects.

==== What will you do to ensure that your accepted students stick with the project after GSoC concludes? ====

We hope that the mentoring process and the experiences they have as part of GSoC will make the students interested in remaining part of Xiph, continuing development on the software they've been working on, and perhaps nurturing their patches towards inclusion in an actual release.

A very important part of GSoC is for us to make them active members of the community, in particular on the irc channels and the mailing lists. Past experience tells that once they have become part of that community, they will stick around for longer.

We will encourage them not to consider this just "a summer job", but as being part of a real community — and doing something that is both interesting, and useful to the wider world.

Summer of Code 2009

2009-03-03T23:09:41Z

Mdale: /* Proof of Concept liboggplay (html5 video) support in Chromium Browser */

Summer of Code 2009

2009-03-03T22:59:29Z

Mdale: /* Metavid related projects */ reworded export desc

Summer of Code 2009

2009-02-27T17:41:04Z

Mdale: /* Detailed Project Description */ heading for metavid projects

Summer of Code 2009

2009-02-27T17:40:20Z

Mdale: added liboggplay chrome support idea

Summer of Code 2009

2009-02-27T16:49:13Z

Mdale: /* Detailed Project Description */

Summer of Code 2009

2009-02-27T02:18:37Z

Mdale: /* Current Ideas */

Summer of Code 2009

2009-02-27T02:18:24Z

Mdale: initial summer of code 2009 page

Summer of Code

2009-02-27T02:15:34Z

Mdale: updaed page to disambiguate

*see [[Summer of Code 2009]]
*see [[Summer of Code 2008]]

Talk:Summer of Code

2009-02-27T02:14:41Z

Mdale: Talk:Summer of Code moved to Talk:Summer of Code 2008: moved 2008 summer of code page to 2008

#REDIRECT [[Talk:Summer of Code 2008]]

Talk:Summer of Code 2008

2009-02-27T02:14:41Z

Mdale: Talk:Summer of Code moved to Talk:Summer of Code 2008: moved 2008 summer of code page to 2008

Summer of Code

2009-02-27T02:14:40Z

Mdale: Summer of Code moved to Summer of Code 2008: moved 2008 summer of code page to 2008

#REDIRECT [[Summer of Code 2008]]

Summer of Code 2008

2009-02-27T02:14:40Z

Mdale: Summer of Code moved to Summer of Code 2008: moved 2008 summer of code page to 2008

This is our ideas page for [http://code.google.com/soc/ Google Summer of Code] projects with [http://xiph.org Xiph.org] and [http://annodex.org/ Annodex]. The two projects participate jointly this year under Xiph's name.

'''Students''' please use the template at [[Summer of Code Applications]] when applying for a GSoC position.

'''Mentors''' please visit [[Summer of Code Mentoring]] and help us prepare our application as a mentoring organization.

== Current Ideas ==

We need a primary and backup mentor volunteer for any project that is to become an official proposal, but submit something and we'll see who we can round up. :)

''Project ideas go here''
* Transcode/Tag/Upload tool for Theora et al. (ideally as a firefox extension so web cms integration is easy) '''OggPusher''' details below:
* Theora encoding support in GIMP
* Cross-platform qt4 wrapper around Xiph encoders. A do-it-all encoder in one simple GUI, possibly drag&drop a la OggDropXPd. This would make it tremendously easy for end-users to encode Theora et al
* Theora Java port directly (semi)automatically derived from the reference sources
* Optimisations for Oggenc and Co. as done by Lancer (http://homepage3.nifty.com/blacksword/) which gives around 3x more speed. If one fears quality lose, make it ./configure option. Lancers diffs only work for Windows.
:The last statement shows why this is a bad idea.
* Speex support in IceS
* Better stream source gui for dvswitch
* XSPF support in ogg123 and oggenc (playlist creation)
* Initial support for OggPCM in some of our tools
* OggMNG tools
:Is this really necessary? I mean, OggMNG seems to have gone nowhere and serve no niche.--Ivo
::We still keep getting asked for a format where speex and images together make up a movie.--Silvia
* ROE implementation for network: using ROE in a client-server negotiation to dynamically request a specific multi-track ogg file using skeleton (Silvia)
* create Ogg caption support for vlc using CMML
* ffmpeg improvements for Xiph codecs:
** add Speex support
** add Ogg Skeleton support
** fix seeking bugs involving Ogg Theora
** fix bugs in Ogg Theora decoder
** improve ogg muxer
* Ogg Cutter, a GUI to cut out segments from Ogg Videos, this could be based on oggz-chop (part of oggz-tools) or done with Gstreamer (starting with [http://webcvs.freedesktop.org/gstreamer/gst-python/examples/remuxer.py?content-type=text%2Fplain&view=co remuxer.py])
* Improve [http://xiph.org/quicktime/ Xiph QuickTime Components]:
** add Ogg Skeleton support (would make XiphQT able to properly play streams served with mod_annodex)
** add FLAC and Speex encoding support
** improve user interface of the Ogg exporter
** add AudioFile components supporting Ogg and FLAC files (to make XiphQT available to applications using only CoreAudio without QuickTime)
* Portable [http://rarewares.org/ogg-oggenc.php oggenc2] --[[User:Fp|Fp]] 02:26, 14 May 2008 (PDT)
** oggenc2 is a fork of xiph.org oggenc available for the Win32 platform. Sources are available under the GPL. Unfortunately it does not compile under POSIX systems. Oggenc2 has a lot of features and bug fixes over xiph.org oggenc, e.g.:
*** use of libsamplerate for resampling, giving a higher quality;
*** support of 32 bit and floating point WAV format for input;
** this project should port all the improvements in oggenc2 to oggenc. Note that the two projects are diverged somewhat and so oggenc may have some other features that oggenc2 have not, so a straight port of oggenc2 to POSIX could not be the right approach. The best way is to get the source of all versions of oggenc2, do a diff between them and try to apply in oggenc.

==Detailed Project Description==

===Mv_Embed: Accessibility and [re]usability:===
'''Mentor:''' Michael Dale, Anna (EngageMedia) 
'''Existing Feature Set:''' [http://metavid.ucsc.edu/wiki/index.php/Mv_Embed Mv_Embed] is an existing javascript library that takes html5 <video> tag and rewrites the video tag for to support in-page ogg theora playback in contemporary browsers. MV_embed supports may browsers and plugins including: native browser support such as firefox 3 video builds, oggplay plugin for firefox2 in win, mac, linux ; VLC activX/plugin for win IE, firefox, and mac, linux firefox; mplayer & totem for linux; and java cortado for microsoft, sun, apple java VM for IE, firefox & safari. Mv_embed maps all these plugin javascript systems to a ~near~ html5 spec api enabling web application developers to take advantage of a uniform javascript API for video control and interaction without having to worry about the underling plugin systems. Mv_Embed is used as part of the metavidWiki Project (screen cast).

'''Proposed Development:''' Mv_Embed will be enhanced around two goals integration into prominent open source Content Management Systems and better accessibility of close captions and associative video metadata.

Mv_Embed will integrate into existing CMS video extensions for quick "one-off" ogg theora support.
* FilmForge (Drupal)
* ShowInABox (Wordpress)
* Plumi (Plone)

Additional server side components like transcoding to theora, generating thumbnails, and exporting metadata will also be developed. Where time / resources permit server side hooks into ffmepg2theora (for transcoding) and mplayer (for generating thumbnails) will be developed for the CMS systems as well. As OggPusher matures simple hooks will be added to the CMS's to support direct ogg theora clip uploads.

'''Accessibility & CMML'''
Accessible components of mv_embed consist of obtaining the metadata and putting it into the dom as a child of the video element. Mv_Embed will offer a reference javascript interface for client interactions with that metadata. The metadata will be structured in Continues Media Markup Language (CMML). CMML is a part of the annodex technology set and can either be muxed into the ogg stream or be requested separately via XML. Mv_Embed will negotiate a transport method for the metadata that will work for the given plugin type.(Currently only oggplay plugin supports ogg-skeleton and exposing muxed CMML tracks in the ogg stream).

Mv_Embed is part of [http://metavid.ucsc.edu/wiki/index.php/MetaVidWiki MetavidWiki] enables community authored transcripts and exposes these multiple layers in CMML. Proposed work on Mv_Embed will generalize these development efforts taking place in the metavid project for other CMS's and improve the usability and accessibility of these metadata layers in javascript based interfaces and mutil-plugin playback environment.

=== Theora Java port directly (semi)automatically derived from the reference sources ===

The current Java decoder port (jheora) is rapidly heading towards becoming obsolete. It was based on the C reference implementation during alpha development stages, which means it cannot decode advanced Theora streams using non-VP3 features. Current Theora mainline features a completely new decoder, implementing all bitstream features, and a new encoder needing these advanced decoder capabilities is expected to arrive soon. jheora, however, appears to be unmaintainable for very same reasons the original alpha decoder was dropped. To make matters worse there's a very very noticable lack of someone being at least moderately skilled in Java AND being skilled in video coding AND writing Java code with acceptable speed (video decoding should be realtime). Any conventional manual Java source port may quickly bitrot to an unmaintainable state.

Thankfully there *are* technologies to get C code to execute in the Java Virtual Machine. The obvious idea would be to translate the actual source code to Java using an automated process, but no reliable tools exist doing this (and given the concept-clash in some areas between C and Java it's unlikely something really nice will emerge). Projects like NestedVM (http://nestedvm.ibex.org/) and Cibyl (http://spel.bth.se/index.php/Cibyl) are doing '''language agnostic translations to Java bytecode''', using the GCC toolchain.

In the first step the code to be ported is compiled to MIPS ELF binaries. Those are then converted to Java bytecode. This works pretty well because MIPS is pretty similar to Java bytecode and most instructions can be mapped directly.

Crazyness? Work of mad men, living in nuclear families, fighting rampaging robots with nuclear missiles? Does this actually work? Yup, it does work, and some Xiph encoders/decoders have been successfully converted with NestedVM already (http://groups.google.com/group/nestedvm/browse_thread/thread/df96ef7337f390e4/a45fdd66534e7641?#a45fdd66534e7641) and figures provided by the Cibyl project indicate that the MIPS-to-Java approach isn't actually slower than a "real" Java port (http://spel.bth.se/index.php/Cibyl_performance) - it's sometimes faster, sometimes slower.

The problem with NestedVM is that there appears to be no means to generate a Java interface from the converted binaries - which means that while the converted binaries work fine on Java there's no way to call the functionality of the converted code by other Java classes, which would be necessary to e.g. write a player applet.

Cibyl, on the other hand, does provide means to generate Java interfaces, given the binary and the header files. Cibyl, however, needs to link some helper symbols into the MIPS binary, which apparently requires some tricks to work in the usual autoconf setup (http://groups.google.com/group/cibyl-devel/browse_thread/thread/584e5fc3b9bc7e2c). So for the Cibyl port to work some autoconf magic may be necessary.

So what should this project do:

* Create and document a working setup for doing language-agnostic Java conversions
* Demonstrate this for Theora
* Find a way to generate a Java interface in a way being automated as much as possible

This project most likely is directly bound to progress made with either NestedVM or Cibyl. The upside of this is that any results may be directly applied to other projects, too

--[[User:Maikmerten|Maikmerten]] 03:43, 12 March 2008 (PDT)

===OggPusher===
'''Mentor:''' Michael Dale ... or anyone else with more experience with firefox extensions/ffmpeg2theora ? 
'''Abstract:''' OggPusher is a proposed cross platform packaging of ffmpeg2theora as a browser extension. This exposes JavaScript hooks to web applications enabling easy client side transcodes from high quality source originals such as DV or MPEG2 and uploading into web based content management systems. 
'''Sample Application Flow:''' is as follows: A user visits a oggPusher enabled web service. The firefox user is prompted to install a browser extension via firefox's .xpi extension framework. Once enabled, the web service upload interface does a call to the oggPusher to expose a "open file" dialog box on the client. The websevice access the oggPusher api to set the requested transcode bitrate and other transcode options (such as interlace, number of audio channels, resolution etc). The client selects the high quality local file and begins transcoding to a temporary location on local disk. If there is an error in transcoding the upload is aborted and an error is exposed to web application. Once the file is done transcoding, the web interface has the client issue a POST of the transcoded file.(if the server supports more efficient PUT than that can be used). The amount of the file that has been transcoded and the amount uploaded are exposed via javascript hooks so that web application javascript interface can update the client on upload progress. If the the upload connection is reset a ajax request on the client can request "bytes upload so far" from the server and have oggPusher begin uploading from that point in the temporary local ogg file. A local file hash could be rechecked to insure the local file has not changed. The server can then do a simple join on the uploaded pieces, enabling reusable uploads over existing http protocol. If the server does not support resumes the file will be uploaded from the start.

'''Features for initial Release:'''
* A .xpi extension based on ffmpeg2theoa that supports uploading of local files of any type that ffmpeg accepts.
* Supports two modes of operation
** zero server side config where oggPusher just gives the option of uploading theora video where it finds a form file input type.
** server side config where the server/service hooks into oggPusher for extra functionality, like resuming transferrer and status updates integrated with the web application.
* A simple javascript api for controlling ffmpeg2theora encoding options. These options will be pre-demerited and javascript input will be scrubbed to avoid client side security risks.
* A set of javascript hooks for oggPusher that expose upload progress, encoding progress and transcoding errors.
* A sample server side implementation using php/html/javascript for grabbing ogg files from oggPusher.

'''Future Feature RoadMap:'''
Once the basic implementation has been deployed the following features will be targeted for future versions:

* Integration with popular open source CMS's first target is mediaWiki.
* Hooks for connecting into "live" interfaces such as firewire digital video input or USB web cams.
** Extend oggfwd and server side components for in browser live streaming to web services.
* Extend to support ffmpeg2Dirac and future open source media codecs.
* Enable javascript hooks for grabbing highquality jpg or png screen grabs from the original source to be uploaded alongside the encoded video.
* Enable Bittorrent uploads

===XSPF support in oggenc and ogg123 applications===

Mentor: Ivo Emanuel Gonçalves 
Existing Feature Set: oggenc and ogg123 are part of a toolset named vorbis-tools, where oggenc is a Vorbis encoder and ogg123 an audio player. XSPF is a XML-based playlist format, extensible, but simple and efficient.

Proposed Development: this project would extend those two applications (oggenc and ogg123) to support XSPF. Namely, oggenc would be able to generate a playlist from the encoded files, and ogg123 would be able to parse a playlist for supported media for playback. This is a C project, with the intention of using code from or actually linking to the BSD-licensed libSpiff, which is a C++ XSPF library.

===php_annodex: wrapper to libannodex or liboggz for doing media stuff===

'''Mentor:''' Silvia Pfeiffer ... or anyone else with an a php background e.g. Michael Dale 

'''What is it?'''
Direct interaction with Ogg video and audio files from within a Web scripting language is key to providing further support to existing and new Web media applications. php_annodex can e.g. be used to extend Drupal, MediaWiki and other php-based applications with function calls to control opening, closing, seeking, playing, pausing, telling position and similar interactions with audio/video. Further, since Annodex has CMML for time-aligned annotations, hyperlinks to other places, and textual descriptions (such as captions) can be accessed and used through php_annodex.

'''What is the project?'''
An initial version of [http://annodex.net/software/phpannodex/index.html php_annodex exists], but it is incomplete and not up-to-date. This is in comparison with such support in python through [http://annodex.net/taxonomy_menu/1/19 pyannodex]. A GSoC student would be expected to bring the support for Xiph and Annodex technology in php_annodex up-to-date. In addition, he/she could extend this work by also implementing media support in a plugin, e.g. the Drupal module [http://annodex.net/software/phpannodex/index.html Acidfree]. php_annodex is simply a php wrapper around the C-libraries libannodex and liboggz. It may suffice to just focus on liboggz.

===ruby_annodex: wrapper to libannodex or liboggz for doing media stuff===

'''Mentor:''' Silvia Pfeiffer 

'''What is it?'''
Direct interaction with Ogg video and audio files from within a Web scripting language is key to providing further support to existing and new Web media applications. ruby_annodex can e.g. be used to extend rails with function calls to control opening, closing, seeking, playing, pausing, telling position and similar interactions with audio/video. Further, since Annodex has CMML for time-aligned annotations, hyperlinks to other places, and textual descriptions (such as captions) can be accessed and used through ruby_annodex.

'''What is the project?'''
A python wrapper of similar type called [http://annodex.net/taxonomy_menu/1/19 pyannodex] exists. The ruby_annodex wrapper should provide similar functionality to ruby, in particular with a view of using it from within rails for the development of Web applications. Development of an example application in ruby on rails would be part of this. Extension of this project to include media support into a ruby-based CMS is possible.

===Using ROE to create multi-track Ogg files===

'''Mentor:''' Silvia Pfeiffer ... and anyone else interested in ROE, e.g. Ralph Giles, Conrad Parker, Michael Dale, Shane Stephens 

'''What is it?'''
[http://trac.annodex.net/wiki/MovieDescriptionLanguage ROE] is a small XML description language for multi-track media files. It can be used for authoring multi-track media files from separate physical files on disk. It can also be used on a Web server to dynamically create multi-track media resources where the tracks are selected through the request from the client.

'''What is the project?'''
In this project, we only implement and experiment with the file multiplexing side of things. The ROE specification is very new and potentially incomplete, so part of the project will be to validate this specification. The other part will be to create an authoring tool that can take a ROE file, parse it, pull in all the input audio, video, text etc files and create an Ogg file with a Skeleton that contains the equivalent of ROE inside the binary file. The project will start with a focus on multiplexing vorbis audio and theora video, but also include speex, FLAC, CMML, and possibly MNG data. If this is achieved in a short time frame, the project can continue onto developing support for these multi-track files in e.g. vlc or ffmpeg. This can even extend to providing a full tool-chain from authoring captions for a video file, to creating the respective multitrack Ogg file, and finally to playing them back inside vlc where the captions are shown as overlays.

===SHARE application for the Spread Open Media project===

Mentor: Ivo Emanuel Gonçalves 
Existing Feature Set: Spread Open Media is a community project to promote the different free formats for multimedia and otherwise. SHARE is a pratical step to build on this community and spread more files.

Proposed Development: SHARE is intended to be a PHP project. We do not discard the possibility of using Rails or Python, but the current SOM server does not support these. SHARE will be a WebJay-like clone, as in users will be able to register, vote, comment and upload their own XSPF playlists. Basically, it is a playlist sharing application. Using OpenID for registration and Cortado (an existing Java applet) for playback would be welcome additions.

=== Cross-platform Xiph encoder wrapper in qt4 ===

Mentor: Not specified yet 
Existing Feature Set: qt4 is a cross-platform C++ widget toolkit, which makes it easy to create GUI programs. Xiph has encoders for all of its main formats, but they are command line only, which a big no-no for the average user.

Proposed Development: The idea is to create a qt4 wrapper around those encoders to make it easier for anyone to encode media into Vorbis, Speex, Theora and FLAC. This would likely boost the popularity of said formats tremendously.

===Dirac support in liboggplay and liboggz===

'''Mentor:''' ??

Right now [http://wiki.xiph.org/index.php/OggPlay liboggplay] only support Theora video.
Your aim for this project is to add support for [http://dirac.sourceforge.net/ Dirac],
this should be done using [http://www.diracvideo.org/ libschrodinger].
Doing this, you will add OggDirac support to the OggPlay Browser Plugin and the upcoming <video> tag support in Firefox.

== Guidelines for Applying ==

Remember that many people will apply to work on the Summer of Code.

Keep in mind that those of us evaluating your application do not know you, we do not know what kind of
experience you have, we do not know what you have done in the past and we have to pick the best people
suited for a particular task.

Hence, it is very important that you tell us in your email why you should be considered to implement a
particular project. Please use the application template at [[Summer of Code Applications]] as a starting point.

== See Also ==
*[[Todo]]
*[[Bounties]]
*[[CodingGuidelines]]
*[[MIT approach to design and implementation]]
*[[How to do a release]]
*[[Summer of Code 2007]]
*[[Summer of Code 2006]]

ROE

2008-12-19T16:34:37Z

Mdale: /* ROE in Use */

= Overview =

ROE (Rich Open multitrack media Exposition) is a way of describing the relationships between tracks of media in a stream. It is used to group tracks which have similar purpose and to identify alternatives.

= Usage =

== Authoring ==
One use of ROE is to author a multi-track audio-visual stream from multiple input files. In this document, we present a description of how to use ROE to author multi-track Ogg files.

== Dynamic Web Requests ==
Another use of ROE is in a Web client-server scenario. The Web server uses ROE as a means of representing the different tracks that are available for a multi-track Web resource. A Web client may not require all available tracks to present the resource to the user. It may decide to request the ROE representation first and then request only a subset of tracks from the server, e.g. only the English soundtrack. Or it may directly request particular tracks only. The server will use the request from the client to dynamically compose a multi-track stream with the requested tracks and mandatory tracks and serve this to satisfy the resource request.

== ROE in Use ==
A draft version of the spec is in use in the mediaWiki extension [http://metavid.org/w/index.php/MetaVidWiki MetaVidWiki]. This runs on the site [http://metavid.org metavid.org] and is used for remote embeding. In [http://metavid-mike.blogspot.com/ this blog] for example all the clips refrence a single roe file to expose multiple video tracks and text transcripts. [http://metavid.org/w/index.php?title=Special:MvExportStream&feed_format=roe&stream_name=House_proceeding_06-09-08_01&t=0%3A01%3A38%2F0%3A10%3A00 Sample ROE output] from metavid

= The ROE model =

Here we describe two representations of ROE: that of ROE XML, and that of ROE in Ogg Skeleton. Each representation is capable of entirely encoding the relationships of the ROE model, such that it is possible to losslessly convert between them.

= ROE XML =

ROE XML is a XML markup language that describes a hierarchical serialization of the ROE model.

A ROE XML file is an instance document of the [http://svn.annodex.net/standards/roe/roe_1_0.xsd ROE XML schema].

It is composed of a <head> tag followed by a <body> tag.

== Head Element ==

=== Head Tags ===
The <head> tag is optional and may optionally contain:

* a <title> tag to provide a textual description for the multi-track stream,
* a set of <link> tags that provide an alternative representation of the multi-track stream, e.g. as a html document,
* a <img> tag to provide a representative thumbnail for the multi-track stream,
* a set of <meta> tags that provide structured name-value annotations of the multi-track stream,
* a <base> tag to provide a base URI for resources referred to in the ROE file, and
* a set of <profile> tags that allows description of so-called track profiles.

The <title>, <link>, <meta>, and <base> tags are taken out of [http://www.w3.org/TR/xhtml1-schema/ XHTML] and serve the same purpose as they serve there.

=== Track Profiles ===
A track profile is a combination of tracks that is pre-defined within the ROE file and can be accessed by Web clients or authoring applications directly. Examples of such profiles are the Director's cut, or the Australian version.

A profile defines a list of references to the tracks of a media resource and possibly a selection from the alternative media sources of the track, to use for a particular pre-defined profile of the resource.

To that end, the profile element has a subelement called "partial" which contains the ID of a selected track and potentially the ID of a selected alternate media source for the track.

An example profile is:

<profile name="director's cut">
<partial track="v" select="v1" />
<partial track="a" />
</profile>

The <head> tag essentially separates the profiles from the core document structure being provided in the <body> element.

== Body Element ==

The <body> tag consists of a sequence of <track> elements that each describe a logical media track.

=== The Track Tag ===
A media track may consist of one of:

* a media source, such as a audio, video, or text stream described in a <mediaSource> tag,
* a sequence of media sources described in a <seq> tag with start and end times, or
* a set of alternate media sources described in a <switch> tag, only one of which can be selected.

The <track> element contains a mandatory "provides" attribute, which introduces a virtual label such as "commentary", "video", "audio", "textoverlay", "closedcaption", "logo", or "scoreboard". The track provides that kind of content.

=== The Switch Tag ===
The <switch> tag provides a choice between alternates, distinguished for a specific reason. The reason is given in the "distinction" attribute of the <switch> tag.

Inside a <switch> tag, the choices can be specified through the following means:

* directly as a <mediaSource>,
* as a sequence of media sources in a <seq> element, or
* as the outcome of another <switch> tag.

Example <switch> element:

<switch distinction="language" default="a3">
<switch id="a1" distinction="bitrate" default="a1b1">
<mediaSource id="a1b1" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b1.oga" />
<mediaSource id="a1b2" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b2.oga" />
</switch>
<mediaSource id="a2" lang="de" content-type="audio/vorbis" src="http://example.com/lang2.oga" />
<seq id="a3">
<mediaSource id="a3a" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3a.oga" />
<mediaSource id="a3b" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3b.oga" />
</seq>
</switch>

In this example, we have a choice between three languages: en, de and fr.
The English language track also comes in two different bitrates.
The French language track comes in two different files that should be played in sequence

=== Inline XML files ===
Some media source elements are XML documents themselves. These can be represented inline in a ROE file. The purpose of this is to contain all or some the annotation information of a media resource inside one XML file. Thus, the "inline" attribute can have the values "false", "partial" or "full".

An example inline XML file is the use of CMML inside a ROE track:

<track id="t1" provides="caption">
<mediaSource id="c" src="http://example.com/cmml1.cmml" inline="partial" content-type="text/cmml" >
<cmml role="caption" xmlns:cmml="http://www.annodex.org/spec/cmml/cmml40">
<cmml:head>
<cmml:title>random 1</cmml:title>
</cmml:head>
<cmml:clip start="t1" end="t2">
<cmml:body>
<html:p><html:span>rillian:</html:span>FOMS rocks</html:p>
</cmml:body>
</cmml:clip>
</cmml>
</mediaSource>
</track>

== An example ROE XML file ==

Putting it all together, here is an example of a ROE XML file:

<?xml version="1.0"?>
<xs:schema targetNamespace="http://www.xiph.org/roe1.0"
xmlns:xs="http://www.w3.org/2001/XMLS
xmlns:html="http://www.w3.org/1999/xhtml"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<ROE>
<head>
<link id="html_linkback" rel="alternate" type="text/html" href="http://example.com/full_video.html"/>
<img id="stream_thumb" src="http://example.com/full_video.jpg"/>
<title>Example video</title>
<profile name="director's cut">
<partial track="v" select="v1" />
<partial track="a" />
</profile>
</head>
<body>
<track id="v" provides="video">
<switch distinction="angle" default="v1">
<mediaSource id="v1" content-type="video/theora" src="http://example.com/angle1.ogv?track=v1&t=t1/t2" />
<mediaSource id="v2" content-type="video/theora" src="http://example.com/angle2.ogv" />
</switch>
</track>
<track id="a" provides="audio">
<switch distinction="Content-Language" default="a3">
<switch id="a1" distinction="bitrate" default="a1b1">
<mediaSource id="a1b1" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b1.oga" />
<mediaSource id="a1b2" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b2.oga" />
</switch>
<mediaSource id="a2" lang="de" content-type="audio/vorbis" src="http://example.com/lang2.oga" />
<seq id="a3">
<mediaSource id="a3a" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3a.oga" />
<mediaSource id="a3b" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3b.org" />
</seq>
</switch>
</track>
<track id="t" provides="text overlay">
<switch distinction="Content-Language" default="t1">
<mediaSource id="t1" lang="en" content-type="text/cmml" src="http://example.com/transcript1.cmml" />
<mediaSource id="t2" lang="de" content-type="text/cmml" src="http://example.com/transcript2.cmml" />
<mediaSource id="t3" lang="fr" content-type="text/cmml" src="http://example.com/transcript3.cmml" />
</switch>
</track>
<track id="l" provides="logo" default="O1">
<seq>
<mediaSource id="O1" content-type="application/ogg" src="http://example.com/mng.ogx?track=1" />
<mediaSource id="O2" content-type="application/ogg" src="http://example.com/mng.ogx?track=2" />
</seq>
</track>
</body>
</ROE>

= Representation in Skeleton =

When the relationships described by ROE are written into an Ogg stream, they are encoded using the message header fields of Ogg Skeleton fisbones for each track. One of the primary design goals for fisbone headers is to minimize the need for global information to be stored in a stream. Each track's fisbone contains headers describing only itself and its relationship to other tracks in the stream. This allows tracks to be inserted or removed at the Ogg level without needing to modify any data in individual headers.

== Relationships ==

Relationships between tracks are given by the following headers:

=== Provides ===

''Provides'' introduces a virtual label such as "commentary", which this track provides. Many tracks may provide the same such label, and as long as one is present then a dependency on that label can be satisfied.

=== Depends ===

This declares that it is not valid to include this track in a stream unless the track it depends on is present. An example use of this might be the generic captioning of sound effects for the deaf, which may not make sense unless the captioning of speech (in an appropriate language) is also rendered.
''Depends'' refers to either a virtual label provided by another track, or an explicit track ID.

When removing a track from a file, any other tracks dependent on it must also be removed.

=== Recommends ===

''Recommends'' refers to either a virtual label provided by another track, or an explicit track ID.

=== Suggests ===

''Suggests'' refers to either a virtual label provided by another track, or an explicit track ID.

=== Conflicts ===

''Conflicts'' refers to either a virtual label provided by another track, or an explicit track ID.

== Serving Suggestions ==

=== Disposition ===

= HTTP-style message headers for client-server negotiation =

ROE

2008-11-04T19:10:36Z

Mdale: added usag example

= Overview =

ROE (Rich Open multitrack media Exposition) is a way of describing the relationships between tracks of media in a stream. It is used to group tracks which have similar purpose and to identify alternatives.

= Usage =

== Authoring ==
One use of ROE is to author a multi-track audio-visual stream from multiple input files. In this document, we present a description of how to use ROE to author multi-track Ogg files.

== Dynamic Web Requests ==
Another use of ROE is in a Web client-server scenario. The Web server uses ROE as a means of representing the different tracks that are available for a multi-track Web resource. A Web client may not require all available tracks to present the resource to the user. It may decide to request the ROE representation first and then request only a subset of tracks from the server, e.g. only the English soundtrack. Or it may directly request particular tracks only. The server will use the request from the client to dynamically compose a multi-track stream with the requested tracks and mandatory tracks and serve this to satisfy the resource request.

== ROE in Use ==
A draft version of the spec is in use in media CMS's such as [http://metavid.org/w/index.php/MetaVidWiki MetaVidWiki]. The Dynamic web request senerio is best illustrated by the mv_embed library remote embedding clips from the metavid archive. This can be seen in [http://metavid-mike.blogspot.com/ this blog] demonstrating its usage. If you view source you can see the roe xml that is making ogg, flash video clips available along with multiple timed text tracks in CMML.

= The ROE model =

Here we describe two representations of ROE: that of ROE XML, and that of ROE in Ogg Skeleton. Each representation is capable of entirely encoding the relationships of the ROE model, such that it is possible to losslessly convert between them.

= ROE XML =

ROE XML is a XML markup language that describes a hierarchical serialization of the ROE model.

A ROE XML file is an instance document of the [http://svn.annodex.net/standards/roe/roe_1_0.xsd ROE XML schema].

It is composed of a <head> tag followed by a <body> tag.

== Head Element ==

=== Head Tags ===
The <head> tag is optional and may optionally contain:

* a <title> tag to provide a textual description for the multi-track stream,
* a set of <link> tags that provide an alternative representation of the multi-track stream, e.g. as a html document,
* a <img> tag to provide a representative thumbnail for the multi-track stream,
* a set of <meta> tags that provide structured name-value annotations of the multi-track stream,
* a <base> tag to provide a base URI for resources referred to in the ROE file, and
* a set of <profile> tags that allows description of so-called track profiles.

The <title>, <link>, <meta>, and <base> tags are taken out of [http://www.w3.org/TR/xhtml1-schema/ XHTML] and serve the same purpose as they serve there.

=== Track Profiles ===
A track profile is a combination of tracks that is pre-defined within the ROE file and can be accessed by Web clients or authoring applications directly. Examples of such profiles are the Director's cut, or the Australian version.

A profile defines a list of references to the tracks of a media resource and possibly a selection from the alternative media sources of the track, to use for a particular pre-defined profile of the resource.

To that end, the profile element has a subelement called "partial" which contains the ID of a selected track and potentially the ID of a selected alternate media source for the track.

An example profile is:

<profile name="director's cut">
<partial track="v" select="v1" />
<partial track="a" />
</profile>

The <head> tag essentially separates the profiles from the core document structure being provided in the <body> element.

== Body Element ==

The <body> tag consists of a sequence of <track> elements that each describe a logical media track.

=== The Track Tag ===
A media track may consist of one of:

* a media source, such as a audio, video, or text stream described in a <mediaSource> tag,
* a sequence of media sources described in a <seq> tag with start and end times, or
* a set of alternate media sources described in a <switch> tag, only one of which can be selected.

The <track> element contains a mandatory "provides" attribute, which introduces a virtual label such as "commentary", "video", "audio", "textoverlay", "closedcaption", "logo", or "scoreboard". The track provides that kind of content.

=== The Switch Tag ===
The <switch> tag provides a choice between alternates, distinguished for a specific reason. The reason is given in the "distinction" attribute of the <switch> tag.

Inside a <switch> tag, the choices can be specified through the following means:

* directly as a <mediaSource>,
* as a sequence of media sources in a <seq> element, or
* as the outcome of another <switch> tag.

Example <switch> element:

<switch distinction="language" default="a3">
<switch id="a1" distinction="bitrate" default="a1b1">
<mediaSource id="a1b1" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b1.oga" />
<mediaSource id="a1b2" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b2.oga" />
</switch>
<mediaSource id="a2" lang="de" content-type="audio/vorbis" src="http://example.com/lang2.oga" />
<seq id="a3">
<mediaSource id="a3a" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3a.oga" />
<mediaSource id="a3b" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3b.oga" />
</seq>
</switch>

In this example, we have a choice between three languages: en, de and fr.
The English language track also comes in two different bitrates.
The French language track comes in two different files that should be played in sequence

=== Inline XML files ===
Some media source elements are XML documents themselves. These can be represented inline in a ROE file. The purpose of this is to contain all or some the annotation information of a media resource inside one XML file. Thus, the "inline" attribute can have the values "false", "partial" or "full".

An example inline XML file is the use of CMML inside a ROE track:

<track id="t1" provides="caption">
<mediaSource id="c" src="http://example.com/cmml1.cmml" inline="partial" content-type="text/cmml" >
<cmml role="caption" xmlns:cmml="http://www.annodex.org/spec/cmml/cmml40">
<cmml:head>
<cmml:title>random 1</cmml:title>
</cmml:head>
<cmml:clip start="t1" end="t2">
<cmml:body>
<html:p><html:span>rillian:</html:span>FOMS rocks</html:p>
</cmml:body>
</cmml:clip>
</cmml>
</mediaSource>
</track>

== An example ROE XML file ==

Putting it all together, here is an example of a ROE XML file:

<?xml version="1.0"?>
<xs:schema targetNamespace="http://www.xiph.org/roe1.0"
xmlns:xs="http://www.w3.org/2001/XMLS
xmlns:html="http://www.w3.org/1999/xhtml"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<ROE>
<head>
<link id="html_linkback" rel="alternate" type="text/html" href="http://example.com/full_video.html"/>
<img id="stream_thumb" src="http://example.com/full_video.jpg"/>
<title>Example video</title>
<profile name="director's cut">
<partial track="v" select="v1" />
<partial track="a" />
</profile>
</head>
<body>
<track id="v" provides="video">
<switch distinction="angle" default="v1">
<mediaSource id="v1" content-type="video/theora" src="http://example.com/angle1.ogv?track=v1&t=t1/t2" />
<mediaSource id="v2" content-type="video/theora" src="http://example.com/angle2.ogv" />
</switch>
</track>
<track id="a" provides="audio">
<switch distinction="Content-Language" default="a3">
<switch id="a1" distinction="bitrate" default="a1b1">
<mediaSource id="a1b1" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b1.oga" />
<mediaSource id="a1b2" lang="en" content-type="audio/vorbis" src="http://example.com/lang1b2.oga" />
</switch>
<mediaSource id="a2" lang="de" content-type="audio/vorbis" src="http://example.com/lang2.oga" />
<seq id="a3">
<mediaSource id="a3a" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3a.oga" />
<mediaSource id="a3b" lang="fr" content-type="audio/vorbis" src="http://example.com/lang3b.org" />
</seq>
</switch>
</track>
<track id="t" provides="text overlay">
<switch distinction="Content-Language" default="t1">
<mediaSource id="t1" lang="en" content-type="text/cmml" src="http://example.com/transcript1.cmml" />
<mediaSource id="t2" lang="de" content-type="text/cmml" src="http://example.com/transcript2.cmml" />
<mediaSource id="t3" lang="fr" content-type="text/cmml" src="http://example.com/transcript3.cmml" />
</switch>
</track>
<track id="l" provides="logo" default="O1">
<seq>
<mediaSource id="O1" content-type="application/ogg" src="http://example.com/mng.ogx?track=1" />
<mediaSource id="O2" content-type="application/ogg" src="http://example.com/mng.ogx?track=2" />
</seq>
</track>
</body>
</ROE>

= Representation in Skeleton =

When the relationships described by ROE are written into an Ogg stream, they are encoded using the message header fields of Ogg Skeleton fisbones for each track. One of the primary design goals for fisbone headers is to minimize the need for global information to be stored in a stream. Each track's fisbone contains headers describing only itself and its relationship to other tracks in the stream. This allows tracks to be inserted or removed at the Ogg level without needing to modify any data in individual headers.

== Relationships ==

Relationships between tracks are given by the following headers:

=== Provides ===

''Provides'' introduces a virtual label such as "commentary", which this track provides. Many tracks may provide the same such label, and as long as one is present then a dependency on that label can be satisfied.

=== Depends ===

This declares that it is not valid to include this track in a stream unless the track it depends on is present. An example use of this might be the generic captioning of sound effects for the deaf, which may not make sense unless the captioning of speech (in an appropriate language) is also rendered.
''Depends'' refers to either a virtual label provided by another track, or an explicit track ID.

When removing a track from a file, any other tracks dependent on it must also be removed.

=== Recommends ===

''Recommends'' refers to either a virtual label provided by another track, or an explicit track ID.

=== Suggests ===

''Suggests'' refers to either a virtual label provided by another track, or an explicit track ID.

=== Conflicts ===

''Conflicts'' refers to either a virtual label provided by another track, or an explicit track ID.

== Serving Suggestions ==

=== Disposition ===

= HTTP-style message headers for client-server negotiation =

List of Theora videos

2008-11-03T20:57:57Z

Mdale: /* Serial and Episodic */ removed dead link (opengov)

This is a list of sites where you can download videos encoded with [[Theora]].

=== Serial and Episodic ===
;[http://www.geekentertainment.tv Geek Entertainment TV]: A weekly video-cast covering technology topics, in an interview format. Many ''Ogg Theora'' format videos in the 2007 and prior archives.
;[http://www.internautas.tv/ INTERNAUTAS TELEVÍSION]: Spanish website with clips from Andaluzian tv station. Content licensed under CC-BY-NC.
;[http://www.linux.com/ Linux.com]: All videos, after late-2007, are in ''Ogg Theora'' format. There is an RSS feed available to be alerted to new videos, as they become available.
;[http://nikosapi.org/video/LAS/ Linux Action Show]: Video broadcast of the Linux Action Show during live recording.
;[http://metavid.org Metavid]: Archive of the House of Representatives and Senate (USA) floor footage.
;[http://video.indypgh.org Rustbelt TV]: [http://pittsburgh.indypgh.org Pittsburgh Indymedia's] TV program based on [http://radio.indypgh.org Rustbelt Radio] (audio available as ogg vorbis).
;[http://ryanishungry.com RyanIsHungry]: Features the stories of individuals hacking everyday life, with environmental sustainability.
;[http://revision3.com/thebroken/ thebroken]: Four technology episodes, from 2003 to 2006, that look at the computer hacker mentality.
;[http://www.thesourceshow.org/ the_source]: A video show providing news, reviews, and general discussion about open source initiatives, since 2006.

=== Video Sharing Services ===
A list of video sharing websites which support the ''upload'' of Ogg files can be found on [http://en.wikipedia.org/wiki/Comparison_of_video_services#Upload_file_formats Wikipedia]. Below is a shorter list of video sharing websites which support the ''download'' of Ogg files.
;[http://blip.tv/search?q=ogg Blip.tv]: A video sharing website which allows the upload and the download of ''Ogg Theora'' files.
;[http://www.engagemedia.org/Members/okvideo/ogg-videos/ Engage Media]: A video sharing website which focuses on social justice and environmental issues in South East Asia.
;[http://theorasea.org/ Theora Sea]: A directory of online and free videos using [http://menguy.aymeric.free.fr/theora/ ITheora].
;[http://tinyvid.tv/ TinyVid]: An experimental Ogg video uploading site, which exists to test out usage of the HTML 5 video and audio elements with the Ogg codecs. You'll need a web browser that can playback Ogg media using ''video'' and ''audio'' tags, to display this video media.
;[http://v2v.cc/ V2V]: A video syndication network which uses only open source software, in order to provide free and equal access to the video source.
;[http://commons.wikimedia.org/ Wikimedia Commons]: An archive database of [http://commons.wikimedia.org/wiki/Special:Statistics more than 3,000,000] media files, to which anyone can contribute.

=== Short Films ===
;[http://intanto.org/cgi-bin/lala.sh?video 11200 Undo]: A short movie about computer, religion, sex, glue and so on...
;[http://www.bigbuckbunny.org/index.php/download/ Big Buck Bunny]: An open content, short animated film by the Blender Institute. Also known as by the project codename, Peach. Available in 720p and smaller sizes.
;[http://wiki.xiph.org/index.php/Elephants_Dream Elephants Dream]: An open content, short animated film by the Blender Institute. Also known as by the project codename, Orange. [http://orange.blender.org/background More about the project...]
;[http://www.polycrystal.org/lego/movies.html Lego Movies]: Two short movies: ''A New Computer'' and ''Swim''.
;[http://www.flashingtwelve.brickfilms.com/Website/films.html More Lego Movies]: Submissions from a Theora-only animation contest.
;[http://dekku.blogspot.com/ No Fat Clips!!!]: Short films, music videos, hip commercials, and other kinds of short visual entertainment. Updated daily. (English and Italian language)
;[http://www.naomiklein.org/shock-doctrine/short-film Shock Doctrine]: A short film by Alfonso Cuarón and Naomi Klein, directed by Jonás Cuarón.
;[http://www.archive.org/details/VoyagetothePlanetofPrehistoricWomen Voyage to the Planet of Prehistoric Women] (1967) and [http://www.archive.org/details/TheSnowCreature The Snow Creature] (1954): Full-length public domain movies from the Internet Archive's [http://www.archive.org/details/feature_films collection].

=== Scientific Demonstrations ===
;[http://ptaff.ca/orage_montreal/?lang=en_CA 1696 Lightnings]: Visual and audible demonstration of a lightning storm in Montreal.
;[http://www.deepvision.ca/tech_example4.php Deep Vision]: Technical demonstrations of the features of Deep Vision's ''Machine Perception''.
;[http://www.rethaw.com/wp/category/videos/ Rethaw]: Conceptual resonance with ice, by David Steinberg.
;[http://selectparks.net/~julian/index.php?entry=entry060602-125815 SysBlog]: Two videos on computer graphic engines: ''fijuu2'' and ''q3apd''.

=== Streaming Media ===
;[http://www.editingarchive.com/eatv/ Editing Archive TV]: Streams unlicensed Japanese anime, amateur machinima films, and video game captures.
;[http://tvmallorca.net/pages/tv_online TV Mallorca]: Streams the ''Mallorca'' television station content through streaming online. (Spanish language)
;[http://www.visonair.tv/ Visonair.tv]: Provides video producers open-access to online media streaming, in a format stylized after a television channel.
;[http://iptv.okto.tv:8080/okto.ogg.m3u Theora Livestream]: from Vienna based community TV station [http://okto.tv Okto]

=== GNU/Linux Philosophical ===
;[http://computerworld.co.nz/news.nsf/news/1461E04FC8D3293FCC2574A500173A09 Computerworld]: Recording of a speech on copyright, at Auckland University, New Zealand.
;[http://support.creativecommons.org/videos/ Creative Commons]: Informational videos about Creative Commons, a charitable corporation which promotes alternative copyright licenses.
;[http://free-electrons.com/community/videos/conferences/en Free Electrons Conferences]: technical talks given at conferences about free software.
;[http://www.gnu.org/fry/ Freedom Fry]: Short film celebrating the 25th anniversary of the GNU operating system, starting Stephen Fry, entitled ''Happy birthday to GNU''.
;[http://audio-video.gnu.org/ GNU and FSF Audio and Video Repository]: Collection of audio and video content, primarily speeches on Free Software.
;[http://gplv3.fsf.org/av GPLv3 Conference, January 16-17 2006]: Speeches by Peter Brown, Eben Moglen and Richard Stallman.
;[http://www.gnu.org/philosophy/audio/audio.html GNU Project's Philosophy Speeches]: Featuring Richard Stallman and others.
;[http://punkcast.com/905/ PUNKCAST#905]: Two speeches by Richard Stallman: ''What's GNU?'' and ''St. IGNUcius''.

=== GNU/Linux Technical ===
;[http://wiki.debconf.org/wiki/Videoteam Debian Videos]: the annual Debian developers meeting, an event filled with discussions and workshops.
;[http://fedoraproject.org/wiki/RenderingProject/aiglx AIGLX]: Demonstration videos for AIGLX, a project that aims to enable GL-accelerated effects on a standard desktop.
;[http://dimitris.glezos.com/weblog/2008/03/26/fosscomm-recap/ Community ''foo'']: A speech by Dimitris Glezos, from the Fedora Project, at FOSSComm 2008. (Greek language)
;[http://linux.dell.com/vlogs/ Dell Linux Engineering Vlogs]: Recordings of interviews from Dell's Linux team, from 2006.
;[http://linmagazine.co.il/fedora/2008/02/06/fedora-9-alpha Fedora 9]: Video demonstration of Resizing feature in Fedora 9. (Hebrew language)
;[http://video.fosdem.org/ FOSDEM Speeches]: Video recordings of ''Free and Open Source'' developer talks held at FOSDEM editions from 2005 and onward.
;[http://dot.kde.org/1213190021/ KDE Day]: Video recordings of technical talks at a conference commemorating the release of KDE 4, in Toulouse, France.
;[http://macslow.thepimp.net/ MacSlow Blog]: A few videos demonstrating GUI elements, linked from a developer's blog.
;[http://www.novell.com/brainshare/keynotes.html Novell Brainshare]: The three keynote speeches which were presented at Novell's Brainshare, in 2006.
;[http://www.redhat.com/solutions/info/videos/ Red Hat Videos]: Videos about the GNU/Linux vendor's customers and solutions.
;[http://tube.opensuse.org/ tube.openSUSE.org]: The official repository of videos by the openSUSE people, such as software developer interviews, instructional screencasts, and conference speeches.
;[http://www.twistedlincoln.com/linuxclass Twisted Lincoln]: Two instructional videos on the use of the GNU/Linux operating system.
;[http://screencasts.ubuntu.com/ Ubuntu Screencasts] and [http://videos.ubuntu.com/ Ubuntu Videos]: Video tutorials and graphical demonstrations on how to use the Ubuntu operating system.

=== Web/Internet Technical ===
;[http://media.annodex.net/cmmlwiki/Special:ListHTML Annodex]: Combination of ''Theora'' video examples, from Open Source Forum 2005 and other events. Annodex applies open standards in annotating and indexing networked media.
;[http://backstage.bbc.co.uk/news/archives/2008/11/george_wright_r.html BBC Backstage Blog]: George Wright responds to ''Backstage'' questions in a video available in ''Theora'' format.
;[http://envycasts.com/ Envy Casts]: Tutorials available for download in ''Ogg Theora'' after purchase. Instructor led training for Ruby on Rails computer programming.
;[http://www.mozilla.com/en-US/firefox/video/videos/FF3_Screencast.ogg Firefox 3 Screencast]: Firefox 3 screenshot and advertising video
;[http://www.double.co.nz/video_test/ Firefox] and [http://dev.opera.com/articles/view/a-call-for-video-on-the-web-opera-vid/ Opera] HTML5 Tests: Implementation examples of the HTML "video tag", using ''Theora'' video formats.
;[http://annevankesteren.nl/2008/09/fronteers-html5-video HTML5 Demonstration]: Anne van Kesteren's Fronteers HTML 5 presentation which has ''video'' tags embedded in the presentation itself.
;[http://lachy.id.au/log/2007/06/webjam3 WebJam 3]: Short video highlight of the WebJam 3, held in 2007. Media is free of copyright restrictions (public domain).

=== Uncatergorized videos ===
;[http://www.pragprog.com/screencasts Pragmatic Programmer]: Technical tutorial screencasts for sale. Some screencasts and screencast previews are available in ''Ogg Vorbis'' format, including ''The Ruby Object Model and Metaprogramming'', ''Erlang by Example'', and ''Everyday Active Record''.
;[http://ulm.ccc.de/ChaosSeminar Ulm CCC Chaosseminar]: Computer-security conference speeches. (German language)

== See also==
{{Template:Theora}}

[[Category:Theora]]

Summer of Code 2008

2008-03-19T01:21:16Z

Mdale: /* Current Ideas */

This is our ideas page for [http://code.google.com/soc/ Google Summer of Code] projects with [http://xiph.org Xiph.org] and [http://annodex.org/ Annodex]. The two projects participate jointly this year under Xiph's name.

'''Students''' please use the template at [[Summer of Code Applications]] when applying for a GSoC position.

'''Mentors''' please visit [[Summer of Code Mentoring]] and help us prepare our application as a mentoring organization.

== Current Ideas ==

We need a primary and backup mentor volunteer for any project that is to become an official proposal, but submit something and we'll see who we can round up. :)

''Project ideas go here''
* Transcode/Tag/Upload tool for Theora et al. (ideally as a firefox extension so web cms integration is easy) '''OggPusher''' details below:
* Improve [http://xiph.org/quicktime/ xiphqt component] support of ogg skeleton streams. (currently does not work with streams served with mod_annodex)
* Theora encoding support in GIMP
* Theora Java port directly (semi)automatically derived from the reference sources
* Optimisations for Oggenc and Co. as done by Lancer (http://homepage3.nifty.com/blacksword/) which gives around 3x more speed. If one fears quality lose, make it ./configure option. Lancers diffs only work for Windows.
* Speex support in IceS
* Better stream source gui for dvswitch
* Multiplexing support (so one can play audio from video files) in ogg123
:Isn't this already done with the vorbisfile support in 1.2.0?
::At first, I thought it wasn't but that's because I tested with a 2.3 GB film and it didn't work. Smaller files work just fine, which makes me believe there's a bug somewhere that needs to be found. Anyway, we can remove this entry.--Ivo
:::2.3 GB is just above what can be represented as bytes on a signed 32 bit int - clue to the bug ? --[[User:Ogg.k.ogg.k|Ogg.k.ogg.k]]
* XSPF support in ogg123 and oggenc (playlist creation)
* Initial support for OggPCM in some of our tools
* OggMNG tools
:Is this really necessary? I mean, OggMNG seems to have gone nowhere and serve no niche.--Ivo
::We still keep getting asked for a format where speex and images together make up a movie.--Silvia
* ROE implementation for network: using ROE in a client-server negotiation to dynamically request a specific multi-track ogg file using skeleton (Silvia)
* create Ogg caption support for vlc using CMML
* ffmpeg improvements for Xiph.Org codecs:
** add Speex support
** add Ogg Skeleton support
** fix seeking bugs involving Ogg Theora
** fix bugs in Ogg Theora decoder
** improve ogg muxer
* Ogg Cutter, a GUI to cut out segments from Ogg Videos, this could be based on oggz-chop (part of oggz-tools) or done with Gstreamer (starting with [http://webcvs.freedesktop.org/gstreamer/gst-python/examples/remuxer.py?content-type=text%2Fplain&view=co remuxer.py]

==Detailed Project Description==

===Mv_Embed: Accessibility and [re]usability:===
'''Mentor:''' Michael Dale, Anna (EngageMedia) 
'''Existing Feature Set:''' [http://metavid.ucsc.edu/wiki/index.php/Mv_Embed Mv_Embed] is an existing javascript library that takes html5 <video> tag and rewrites the video tag for to support in-page ogg theora playback in contemporary browsers. MV_embed supports may browsers and plugins including: native browser support such as firefox 3 video builds, oggplay plugin for firefox2 in win, mac, linux ; VLC activX/plugin for win IE, firefox, and mac, linux firefox; mplayer & totem for linux; and java cortado for microsoft, sun, apple java VM for IE, firefox & safari. Mv_embed maps all these plugin javascript systems to a ~near~ html5 spec api enabling web application developers to take advantage of a uniform javascript API for video control and interaction without having to worry about the underling plugin systems. Mv_Embed is used as part of the metavidWiki Project (screen cast).

'''Proposed Development:''' Mv_Embed will be enhanced around two goals integration into prominent open source Content Management Systems and better accessibility of close captions and associative video metadata.

Mv_Embed will integrate into existing CMS video extensions for quick "one-off" ogg theora support.
* FilmForge (Drupal)
* ShowInABox (Wordpress)
* Plumi (Plone)

Additional server side components like transcoding to theora, generating thumbnails, and exporting metadata will also be developed. Where time / resources permit server side hooks into ffmepg2theora (for transcoding) and mplayer (for generating thumbnails) will be developed for the CMS systems as well. As OggPusher matures simple hooks will be added to the CMS's to support direct ogg theora clip uploads.

'''Accessibility & CMML'''
Accessible components of mv_embed consist of obtaining the metadata and putting it into the dom as a child of the video element. Mv_Embed will offer a reference javascript interface for client interactions with that metadata. The metadata will be structured in Continues Media Markup Language (CMML). CMML is a part of the annodex technology set and can either be muxed into the ogg stream or be requested separately via XML. Mv_Embed will negotiate a transport method for the metadata that will work for the given plugin type.(Currently only oggplay plugin supports ogg-skeleton and exposing muxed CMML tracks in the ogg stream).

Mv_Embed is part of [http://metavid.ucsc.edu/wiki/index.php/MetaVidWiki MetavidWiki] enables community authored transcripts and exposes these multiple layers in CMML. Proposed work on Mv_Embed will generalize these development efforts taking place in the metavid project for other CMS's and improve the usability and accessibility of these metadata layers in javascript based interfaces and mutil-plugin playback environment.

=== Theora Java port directly (semi)automatically derived from the reference sources ===

The current Java decoder port (jheora) is rapidly heading towards becoming obsolete. It was based on the C reference implementation during alpha development stages, which means it cannot decode advanced Theora streams using non-VP3 features. Current Theora mainline features a completely new decoder, implementing all bitstream features, and a new encoder needing these advanced decoder capabilities is expected to arrive soon. jheora, however, appears to be unmaintainable for very same reasons the original alpha decoder was dropped. To make matters worse there's a very very noticable lack of someone being at least moderately skilled in Java AND being skilled in video coding AND writing Java code with acceptable speed (video decoding should be realtime). Any conventional manual Java source port may quickly bitrot to an unmaintainable state.

Thankfully there *are* technologies to get C code to execute in the Java Virtual Machine. The obvious idea would be to translate the actual source code to Java using an automated process, but no reliable tools exist doing this (and given the concept-clash in some areas between C and Java it's unlikely something really nice will emerge). Projects like NestedVM (http://nestedvm.ibex.org/) and Cibyl (http://spel.bth.se/index.php/Cibyl) are doing '''language agnostic translations to Java bytecode''', using the GCC toolchain.

In the first step the code to be ported is compiled to MIPS ELF binaries. Those are then converted to Java bytecode. This works pretty well because MIPS is pretty similar to Java bytecode and most instructions can be mapped directly.

Crazyness? Work of mad men, living in nuclear families, fighting rampaging robots with nuclear missiles? Does this actually work? Yup, it does work, and some Xiph encoders/decoders have been successfully converted with NestedVM already (http://groups.google.com/group/nestedvm/browse_thread/thread/df96ef7337f390e4/a45fdd66534e7641?#a45fdd66534e7641) and figures provided by the Cibyl project indicate that the MIPS-to-Java approach isn't actually slower than a "real" Java port (http://spel.bth.se/index.php/Cibyl_performance) - it's sometimes faster, sometimes slower.

The problem with NestedVM is that there appears to be no means to generate a Java interface from the converted binaries - which means that while the converted binaries work fine on Java there's no way to call the functionality of the converted code by other Java classes, which would be necessary to e.g. write a player applet.

Cibyl, on the other hand, does provide means to generate Java interfaces, given the binary and the header files. Cibyl, however, needs to link some helper symbols into the MIPS binary, which apparently requires some tricks to work in the usual autoconf setup (http://groups.google.com/group/cibyl-devel/browse_thread/thread/584e5fc3b9bc7e2c). So for the Cibyl port to work some autoconf magic may be necessary.

So what should this project do:

* Create and document a working setup for doing language-agnostic Java conversions
* Demonstrate this for Theora
* Find a way to generate a Java interface in a way being automated as much as possible

This project most likely is directly bound to progress made with either NestedVM or Cibyl. The upside of this is that any results may be directly applied to other projects, too

--[[User:Maikmerten|Maikmerten]] 03:43, 12 March 2008 (PDT)

===OggPusher===
'''Mentor:''' Michael Dale ... or anyone else with more experience with firefox extensions/ffmpeg2theora ? 
'''Abstract:''' OggPusher is a proposed cross platform packaging of ffmpeg2theora as a browser extension. This exposes JavaScript hooks to web applications enabling easy client side transcodes from high quality source originals such as DV or MPEG2 and uploading into web based content management systems. 
'''Sample Application Flow:''' is as follows: A user visits a oggPusher enabled web service. The firefox user is prompted to install a browser extension via firefox's .xpi extension framework. Once enabled, the web service upload interface does a call to the oggPusher to expose a "open file" dialog box on the client. The websevice access the oggPusher api to set the requested transcode bitrate and other transcode options (such as interlace, number of audio channels, resolution etc). The client selects the high quality local file and begins transcoding to a temporary location on local disk. If there is an error in transcoding the upload is aborted and an error is exposed to web application. Once the file is done transcoding, the web interface has the client issue a POST of the transcoded file.(if the server supports more efficient PUT than that can be used). The amount of the file that has been transcoded and the amount uploaded are exposed via javascript hooks so that web application javascript interface can update the client on upload progress. If the the upload connection is reset a ajax request on the client can request "bytes upload so far" from the server and have oggPusher begin uploading from that point in the temporary local ogg file. A local file hash could be rechecked to insure the local file has not changed. The server can then do a simple join on the uploaded pieces, enabling reusable uploads over existing http protocol. If the server does not support resumes the file will be uploaded from the start.

'''Features for initial Release:'''
* A .xpi extension based on ffmpeg2theoa that supports uploading of local files of any type that ffmpeg accepts.
* Supports two modes of operation
** zero server side config where oggPusher just gives the option of uploading theora video where it finds a form file input type.
** server side config where the server/service hooks into oggPusher for extra functionality, like resuming transferrer and status updates integrated with the web application.
* A simple javascript api for controlling ffmpeg2theora encoding options. These options will be pre-demerited and javascript input will be scrubbed to avoid client side security risks.
* A set of javascript hooks for oggPusher that expose upload progress, encoding progress and transcoding errors.
* A sample server side implementation using php/html/javascript for grabbing ogg files from oggPusher.

'''Future Feature RoadMap:'''
Once the basic implementation has been deployed the following features will be targeted for future versions:

* Integration with popular open source CMS's first target is mediaWiki.
* Hooks for connecting into "live" interfaces such as firewire digital video input or USB web cams.
** Extend oggfwd and server side components for in browser live streaming to web services.
* Extend to support ffmpeg2Dirac and future open source media codecs.
* Enable javascript hooks for grabbing highquality jpg or png screen grabs from the original source to be uploaded alongside the encoded video.
* Enable Bittorrent uploads

===XSPF support in oggenc and ogg123 applications===

Mentor: Ivo Emanuel Gonçalves 
Existing Feature Set: oggenc and ogg123 are part of a toolset named vorbis-tools, where oggenc is a Vorbis encoder and ogg123 an audio player. XSPF is a XML-based playlist format, extensible, but simple and efficient.

Proposed Development: this project would extend those two applications (oggenc and ogg123) to support XSPF. Namely, oggenc would be able to generate a playlist from the encoded files, and ogg123 would be able to parse a playlist for supported media for playback. This is a C project, with the intention of using code from or actually linking to the BSD-licensed libSpiff, which is a C++ XSPF library.

===php_annodex: wrapper to libannodex or liboggz for doing media stuff===

'''Mentor:''' Silvia Pfeiffer ... or anyone else with an a php background e.g. Michael Dale 

'''What is it?'''
Direct interaction with Ogg video and audio files from within a Web scripting language is key to providing further support to existing and new Web media applications. php_annodex can e.g. be used to extend Drupal, MediaWiki and other php-based applications with function calls to control opening, closing, seeking, playing, pausing, telling position and similar interactions with audio/video. Further, since Annodex has CMML for time-aligned annotations, hyperlinks to other places, and textual descriptions (such as captions) can be accessed and used through php_annodex.

'''What is the project?'''
An initial version of [http://annodex.net/software/phpannodex/index.html php_annodex exists], but it is incomplete and not up-to-date. This is in comparison with such support in python through [http://annodex.net/taxonomy_menu/1/19 pyannodex]. A GSoC student would be expected to bring the support for Xiph and Annodex technology in php_annodex up-to-date. In addition, he/she could extend this work by also implementing media support in a plugin, e.g. the Drupal module [http://annodex.net/software/phpannodex/index.html Acidfree]. php_annodex is simply a php wrapper around the C-libraries libannodex and liboggz. It may suffice to just focus on liboggz.

===ruby_annodex: wrapper to libannodex or liboggz for doing media stuff===

'''Mentor:''' Silvia Pfeiffer 

'''What is it?'''
Direct interaction with Ogg video and audio files from within a Web scripting language is key to providing further support to existing and new Web media applications. ruby_annodex can e.g. be used to extend rails with function calls to control opening, closing, seeking, playing, pausing, telling position and similar interactions with audio/video. Further, since Annodex has CMML for time-aligned annotations, hyperlinks to other places, and textual descriptions (such as captions) can be accessed and used through ruby_annodex.

'''What is the project?'''
A python wrapper of similar type called [http://annodex.net/taxonomy_menu/1/19 pyannodex] exists. The ruby_annodex wrapper should provide similar functionality to ruby, in particular with a view of using it from within rails for the development of Web applications. Development of an example application in ruby on rails would be part of this. Extension of this project to include media support into a ruby-based CMS is possible.

===Using ROE to create multi-track Ogg files===

'''Mentor:''' Silvia Pfeiffer ... and anyone else interested in ROE, e.g. Ralph Giles, Conrad Parker, Michael Dale, Shane Stephens 

'''What is it?'''
[http://trac.annodex.net/wiki/MovieDescriptionLanguage ROE] is a small XML description language for multi-track media files. It can be used for authoring multi-track media files from separate physical files on disk. It can also be used on a Web server to dynamically create multi-track media resources where the tracks are selected through the request from the client.

'''What is the project?'''
In this project, we only implement and experiment with the file multiplexing side of things. The ROE specification is very new and potentially incomplete, so part of the project will be to validate this specification. The other part will be to create an authoring tool that can take a ROE file, parse it, pull in all the input audio, video, text etc files and create an Ogg file with a Skeleton that contains the equivalent of ROE inside the binary file. The project will start with a focus on multiplexing vorbis audio and theora video, but also include speex, FLAC, CMML, and possibly MNG data. If this is achieved in a short time frame, the project can continue onto developing support for these multi-track files in e.g. vlc or ffmpeg. This can even extend to providing a full tool-chain from authoring captions for a video file, to creating the respective multitrack Ogg file, and finally to playing them back inside vlc where the captions are shown as overlays.

===SHARE application for the Spread Open Media project===

Mentor: Ivo Emanuel Gonçalves 
Existing Feature Set: Spread Open Media is a community project to promote the different free formats for multimedia and otherwise. SHARE is a pratical step to build on this community and spread more files.

Proposed Development: SHARE is intended to be a PHP project. We do not discard the possibility of using Rails or Python, but the current SOM server does not support these. SHARE will be a WebJay-like clone, as in users will be able to register, vote, comment and upload their own XSPF playlists. Basically, it is a playlist sharing application. Using OpenID for registration and Cortado (an existing Java applet) for playback would be welcome additions.

===Dirac support in liboggplay and liboggz===

'''Mentor:''' ??

Right now [http://wiki.xiph.org/index.php/OggPlay liboggplay] only support Theora video.
Your aim for this project is to add support for [http://dirac.sourceforge.net/ Dirac],
this should be done using [http://www.diracvideo.org/ libschrodinger].
Doing this, you will add OggDirac support to the OggPlay Browser Plugin and the upcoming <video> tag support in Firefox.

== Guidelines for Applying ==

Remember that many people will apply to work on the Summer of Code.

Keep in mind that those of us evaluating your application do not know you, we do not know what kind of
experience you have, we do not know what you have done in the past and we have to pick the best people
suited for a particular task.

Hence, it is very important that you tell us in your email why you should be considered to implement a
particular project. Please use the application template at [[Summer of Code Applications]] as a starting point.

== See Also ==
*[[CodingGuidelines]]
*[[MIT approach to design and implementation]]
*[[How to do a release]]
*[[Summer of Code 2007]]
*[[Summer of Code 2006]]

Summer of Code 2008

2008-03-19T01:20:50Z

Mdale: /* Current Ideas */

This is our ideas page for [http://code.google.com/soc/ Google Summer of Code] projects with [http://xiph.org Xiph.org] and [http://annodex.org/ Annodex]. The two projects participate jointly this year under Xiph's name.

'''Students''' please use the template at [[Summer of Code Applications]] when applying for a GSoC position.

'''Mentors''' please visit [[Summer of Code Mentoring]] and help us prepare our application as a mentoring organization.

== Current Ideas ==

We need a primary and backup mentor volunteer for any project that is to become an official proposal, but submit something and we'll see who we can round up. :)

''Project ideas go here''
* Transcode/Tag/Upload tool for Theora et al. (ideally as a firefox extension so web cms integration is easy) '''OggPusher''' details below:
* Improve [http://xiph.org/quicktime/ xiphqt component] support of ogg skeleton streams. (currently does not work with mod_annodex streams)
* Theora encoding support in GIMP
* Theora Java port directly (semi)automatically derived from the reference sources
* Optimisations for Oggenc and Co. as done by Lancer (http://homepage3.nifty.com/blacksword/) which gives around 3x more speed. If one fears quality lose, make it ./configure option. Lancers diffs only work for Windows.
* Speex support in IceS
* Better stream source gui for dvswitch
* Multiplexing support (so one can play audio from video files) in ogg123
:Isn't this already done with the vorbisfile support in 1.2.0?
::At first, I thought it wasn't but that's because I tested with a 2.3 GB film and it didn't work. Smaller files work just fine, which makes me believe there's a bug somewhere that needs to be found. Anyway, we can remove this entry.--Ivo
:::2.3 GB is just above what can be represented as bytes on a signed 32 bit int - clue to the bug ? --[[User:Ogg.k.ogg.k|Ogg.k.ogg.k]]
* XSPF support in ogg123 and oggenc (playlist creation)
* Initial support for OggPCM in some of our tools
* OggMNG tools
:Is this really necessary? I mean, OggMNG seems to have gone nowhere and serve no niche.--Ivo
::We still keep getting asked for a format where speex and images together make up a movie.--Silvia
* ROE implementation for network: using ROE in a client-server negotiation to dynamically request a specific multi-track ogg file using skeleton (Silvia)
* create Ogg caption support for vlc using CMML
* ffmpeg improvements for Xiph.Org codecs:
** add Speex support
** add Ogg Skeleton support
** fix seeking bugs involving Ogg Theora
** fix bugs in Ogg Theora decoder
** improve ogg muxer
* Ogg Cutter, a GUI to cut out segments from Ogg Videos, this could be based on oggz-chop (part of oggz-tools) or done with Gstreamer (starting with [http://webcvs.freedesktop.org/gstreamer/gst-python/examples/remuxer.py?content-type=text%2Fplain&view=co remuxer.py]

==Detailed Project Description==

===Mv_Embed: Accessibility and [re]usability:===
'''Mentor:''' Michael Dale, Anna (EngageMedia) 
'''Existing Feature Set:''' [http://metavid.ucsc.edu/wiki/index.php/Mv_Embed Mv_Embed] is an existing javascript library that takes html5 <video> tag and rewrites the video tag for to support in-page ogg theora playback in contemporary browsers. MV_embed supports may browsers and plugins including: native browser support such as firefox 3 video builds, oggplay plugin for firefox2 in win, mac, linux ; VLC activX/plugin for win IE, firefox, and mac, linux firefox; mplayer & totem for linux; and java cortado for microsoft, sun, apple java VM for IE, firefox & safari. Mv_embed maps all these plugin javascript systems to a ~near~ html5 spec api enabling web application developers to take advantage of a uniform javascript API for video control and interaction without having to worry about the underling plugin systems. Mv_Embed is used as part of the metavidWiki Project (screen cast).

'''Proposed Development:''' Mv_Embed will be enhanced around two goals integration into prominent open source Content Management Systems and better accessibility of close captions and associative video metadata.

Mv_Embed will integrate into existing CMS video extensions for quick "one-off" ogg theora support.
* FilmForge (Drupal)
* ShowInABox (Wordpress)
* Plumi (Plone)

Additional server side components like transcoding to theora, generating thumbnails, and exporting metadata will also be developed. Where time / resources permit server side hooks into ffmepg2theora (for transcoding) and mplayer (for generating thumbnails) will be developed for the CMS systems as well. As OggPusher matures simple hooks will be added to the CMS's to support direct ogg theora clip uploads.

'''Accessibility & CMML'''
Accessible components of mv_embed consist of obtaining the metadata and putting it into the dom as a child of the video element. Mv_Embed will offer a reference javascript interface for client interactions with that metadata. The metadata will be structured in Continues Media Markup Language (CMML). CMML is a part of the annodex technology set and can either be muxed into the ogg stream or be requested separately via XML. Mv_Embed will negotiate a transport method for the metadata that will work for the given plugin type.(Currently only oggplay plugin supports ogg-skeleton and exposing muxed CMML tracks in the ogg stream).

Mv_Embed is part of [http://metavid.ucsc.edu/wiki/index.php/MetaVidWiki MetavidWiki] enables community authored transcripts and exposes these multiple layers in CMML. Proposed work on Mv_Embed will generalize these development efforts taking place in the metavid project for other CMS's and improve the usability and accessibility of these metadata layers in javascript based interfaces and mutil-plugin playback environment.

=== Theora Java port directly (semi)automatically derived from the reference sources ===

The current Java decoder port (jheora) is rapidly heading towards becoming obsolete. It was based on the C reference implementation during alpha development stages, which means it cannot decode advanced Theora streams using non-VP3 features. Current Theora mainline features a completely new decoder, implementing all bitstream features, and a new encoder needing these advanced decoder capabilities is expected to arrive soon. jheora, however, appears to be unmaintainable for very same reasons the original alpha decoder was dropped. To make matters worse there's a very very noticable lack of someone being at least moderately skilled in Java AND being skilled in video coding AND writing Java code with acceptable speed (video decoding should be realtime). Any conventional manual Java source port may quickly bitrot to an unmaintainable state.

Thankfully there *are* technologies to get C code to execute in the Java Virtual Machine. The obvious idea would be to translate the actual source code to Java using an automated process, but no reliable tools exist doing this (and given the concept-clash in some areas between C and Java it's unlikely something really nice will emerge). Projects like NestedVM (http://nestedvm.ibex.org/) and Cibyl (http://spel.bth.se/index.php/Cibyl) are doing '''language agnostic translations to Java bytecode''', using the GCC toolchain.

In the first step the code to be ported is compiled to MIPS ELF binaries. Those are then converted to Java bytecode. This works pretty well because MIPS is pretty similar to Java bytecode and most instructions can be mapped directly.

Crazyness? Work of mad men, living in nuclear families, fighting rampaging robots with nuclear missiles? Does this actually work? Yup, it does work, and some Xiph encoders/decoders have been successfully converted with NestedVM already (http://groups.google.com/group/nestedvm/browse_thread/thread/df96ef7337f390e4/a45fdd66534e7641?#a45fdd66534e7641) and figures provided by the Cibyl project indicate that the MIPS-to-Java approach isn't actually slower than a "real" Java port (http://spel.bth.se/index.php/Cibyl_performance) - it's sometimes faster, sometimes slower.

The problem with NestedVM is that there appears to be no means to generate a Java interface from the converted binaries - which means that while the converted binaries work fine on Java there's no way to call the functionality of the converted code by other Java classes, which would be necessary to e.g. write a player applet.

Cibyl, on the other hand, does provide means to generate Java interfaces, given the binary and the header files. Cibyl, however, needs to link some helper symbols into the MIPS binary, which apparently requires some tricks to work in the usual autoconf setup (http://groups.google.com/group/cibyl-devel/browse_thread/thread/584e5fc3b9bc7e2c). So for the Cibyl port to work some autoconf magic may be necessary.

So what should this project do:

* Create and document a working setup for doing language-agnostic Java conversions
* Demonstrate this for Theora
* Find a way to generate a Java interface in a way being automated as much as possible

This project most likely is directly bound to progress made with either NestedVM or Cibyl. The upside of this is that any results may be directly applied to other projects, too

--[[User:Maikmerten|Maikmerten]] 03:43, 12 March 2008 (PDT)

===OggPusher===
'''Mentor:''' Michael Dale ... or anyone else with more experience with firefox extensions/ffmpeg2theora ? 
'''Abstract:''' OggPusher is a proposed cross platform packaging of ffmpeg2theora as a browser extension. This exposes JavaScript hooks to web applications enabling easy client side transcodes from high quality source originals such as DV or MPEG2 and uploading into web based content management systems. 
'''Sample Application Flow:''' is as follows: A user visits a oggPusher enabled web service. The firefox user is prompted to install a browser extension via firefox's .xpi extension framework. Once enabled, the web service upload interface does a call to the oggPusher to expose a "open file" dialog box on the client. The websevice access the oggPusher api to set the requested transcode bitrate and other transcode options (such as interlace, number of audio channels, resolution etc). The client selects the high quality local file and begins transcoding to a temporary location on local disk. If there is an error in transcoding the upload is aborted and an error is exposed to web application. Once the file is done transcoding, the web interface has the client issue a POST of the transcoded file.(if the server supports more efficient PUT than that can be used). The amount of the file that has been transcoded and the amount uploaded are exposed via javascript hooks so that web application javascript interface can update the client on upload progress. If the the upload connection is reset a ajax request on the client can request "bytes upload so far" from the server and have oggPusher begin uploading from that point in the temporary local ogg file. A local file hash could be rechecked to insure the local file has not changed. The server can then do a simple join on the uploaded pieces, enabling reusable uploads over existing http protocol. If the server does not support resumes the file will be uploaded from the start.

'''Features for initial Release:'''
* A .xpi extension based on ffmpeg2theoa that supports uploading of local files of any type that ffmpeg accepts.
* Supports two modes of operation
** zero server side config where oggPusher just gives the option of uploading theora video where it finds a form file input type.
** server side config where the server/service hooks into oggPusher for extra functionality, like resuming transferrer and status updates integrated with the web application.
* A simple javascript api for controlling ffmpeg2theora encoding options. These options will be pre-demerited and javascript input will be scrubbed to avoid client side security risks.
* A set of javascript hooks for oggPusher that expose upload progress, encoding progress and transcoding errors.
* A sample server side implementation using php/html/javascript for grabbing ogg files from oggPusher.

'''Future Feature RoadMap:'''
Once the basic implementation has been deployed the following features will be targeted for future versions:

* Integration with popular open source CMS's first target is mediaWiki.
* Hooks for connecting into "live" interfaces such as firewire digital video input or USB web cams.
** Extend oggfwd and server side components for in browser live streaming to web services.
* Extend to support ffmpeg2Dirac and future open source media codecs.
* Enable javascript hooks for grabbing highquality jpg or png screen grabs from the original source to be uploaded alongside the encoded video.
* Enable Bittorrent uploads

===XSPF support in oggenc and ogg123 applications===

Mentor: Ivo Emanuel Gonçalves 
Existing Feature Set: oggenc and ogg123 are part of a toolset named vorbis-tools, where oggenc is a Vorbis encoder and ogg123 an audio player. XSPF is a XML-based playlist format, extensible, but simple and efficient.

Proposed Development: this project would extend those two applications (oggenc and ogg123) to support XSPF. Namely, oggenc would be able to generate a playlist from the encoded files, and ogg123 would be able to parse a playlist for supported media for playback. This is a C project, with the intention of using code from or actually linking to the BSD-licensed libSpiff, which is a C++ XSPF library.

===php_annodex: wrapper to libannodex or liboggz for doing media stuff===

'''Mentor:''' Silvia Pfeiffer ... or anyone else with an a php background e.g. Michael Dale 

'''What is it?'''
Direct interaction with Ogg video and audio files from within a Web scripting language is key to providing further support to existing and new Web media applications. php_annodex can e.g. be used to extend Drupal, MediaWiki and other php-based applications with function calls to control opening, closing, seeking, playing, pausing, telling position and similar interactions with audio/video. Further, since Annodex has CMML for time-aligned annotations, hyperlinks to other places, and textual descriptions (such as captions) can be accessed and used through php_annodex.

'''What is the project?'''
An initial version of [http://annodex.net/software/phpannodex/index.html php_annodex exists], but it is incomplete and not up-to-date. This is in comparison with such support in python through [http://annodex.net/taxonomy_menu/1/19 pyannodex]. A GSoC student would be expected to bring the support for Xiph and Annodex technology in php_annodex up-to-date. In addition, he/she could extend this work by also implementing media support in a plugin, e.g. the Drupal module [http://annodex.net/software/phpannodex/index.html Acidfree]. php_annodex is simply a php wrapper around the C-libraries libannodex and liboggz. It may suffice to just focus on liboggz.

===ruby_annodex: wrapper to libannodex or liboggz for doing media stuff===

'''Mentor:''' Silvia Pfeiffer 

'''What is it?'''
Direct interaction with Ogg video and audio files from within a Web scripting language is key to providing further support to existing and new Web media applications. ruby_annodex can e.g. be used to extend rails with function calls to control opening, closing, seeking, playing, pausing, telling position and similar interactions with audio/video. Further, since Annodex has CMML for time-aligned annotations, hyperlinks to other places, and textual descriptions (such as captions) can be accessed and used through ruby_annodex.

'''What is the project?'''
A python wrapper of similar type called [http://annodex.net/taxonomy_menu/1/19 pyannodex] exists. The ruby_annodex wrapper should provide similar functionality to ruby, in particular with a view of using it from within rails for the development of Web applications. Development of an example application in ruby on rails would be part of this. Extension of this project to include media support into a ruby-based CMS is possible.

===Using ROE to create multi-track Ogg files===

'''Mentor:''' Silvia Pfeiffer ... and anyone else interested in ROE, e.g. Ralph Giles, Conrad Parker, Michael Dale, Shane Stephens 

'''What is it?'''
[http://trac.annodex.net/wiki/MovieDescriptionLanguage ROE] is a small XML description language for multi-track media files. It can be used for authoring multi-track media files from separate physical files on disk. It can also be used on a Web server to dynamically create multi-track media resources where the tracks are selected through the request from the client.

'''What is the project?'''
In this project, we only implement and experiment with the file multiplexing side of things. The ROE specification is very new and potentially incomplete, so part of the project will be to validate this specification. The other part will be to create an authoring tool that can take a ROE file, parse it, pull in all the input audio, video, text etc files and create an Ogg file with a Skeleton that contains the equivalent of ROE inside the binary file. The project will start with a focus on multiplexing vorbis audio and theora video, but also include speex, FLAC, CMML, and possibly MNG data. If this is achieved in a short time frame, the project can continue onto developing support for these multi-track files in e.g. vlc or ffmpeg. This can even extend to providing a full tool-chain from authoring captions for a video file, to creating the respective multitrack Ogg file, and finally to playing them back inside vlc where the captions are shown as overlays.

===SHARE application for the Spread Open Media project===

Mentor: Ivo Emanuel Gonçalves 
Existing Feature Set: Spread Open Media is a community project to promote the different free formats for multimedia and otherwise. SHARE is a pratical step to build on this community and spread more files.

Proposed Development: SHARE is intended to be a PHP project. We do not discard the possibility of using Rails or Python, but the current SOM server does not support these. SHARE will be a WebJay-like clone, as in users will be able to register, vote, comment and upload their own XSPF playlists. Basically, it is a playlist sharing application. Using OpenID for registration and Cortado (an existing Java applet) for playback would be welcome additions.

===Dirac support in liboggplay and liboggz===

'''Mentor:''' ??

Right now [http://wiki.xiph.org/index.php/OggPlay liboggplay] only support Theora video.
Your aim for this project is to add support for [http://dirac.sourceforge.net/ Dirac],
this should be done using [http://www.diracvideo.org/ libschrodinger].
Doing this, you will add OggDirac support to the OggPlay Browser Plugin and the upcoming <video> tag support in Firefox.

== Guidelines for Applying ==

Remember that many people will apply to work on the Summer of Code.

Keep in mind that those of us evaluating your application do not know you, we do not know what kind of
experience you have, we do not know what you have done in the past and we have to pick the best people
suited for a particular task.

Hence, it is very important that you tell us in your email why you should be considered to implement a
particular project. Please use the application template at [[Summer of Code Applications]] as a starting point.

== See Also ==
*[[CodingGuidelines]]
*[[MIT approach to design and implementation]]
*[[How to do a release]]
*[[Summer of Code 2007]]
*[[Summer of Code 2006]]

Summer of Code Mentoring

2008-03-11T20:59:43Z

Mdale: /* What criteria did you use to select these individuals as mentors? Please be as specific as possible. */

== Xiph.Org Application as a mentoring organization ==

We need to apply for consideration as a mentoring organization 2008 March 3-12. Google lists the following questions in their [http://code.google.com/soc/2008/faqs.html#0.1_org_apply faq]. Our work-in-progress answers are inline.

==== Describe your organization. ====

[http://xiph.org Xiph.Org] is an open source project and non-profit corporation dedicated to providing open and free-to-implement multimedia technology as a foundation for an interoperable, level playing field on the internet and other digital distribution networks. Over the past 8 years we have developed most of the major patent-free audio and video codecs currently in use, including Vorbis, Speex, FLAC and Theora, as well as developing the Ogg streaming format, and the Icecast streaming media server.

This year we are also coordinating projects for the [http://annodex.org Annodex association] under our umbrella. The [http://annodex.net/ Annodex project]
is developing a set of open specifications and open source software to allow the creation of hyperlinked Webs of audio and video integrated with the text-based view of the current Web. Toward this goal, Annodex has done a great deal of work developing tools, browser plugins and convenience libraries to facilitate adoption of Xiph.Org's lower-level technology. As such the two projects have largely aligned goals, but focus on different levels in the stack.

==== Why is your organization applying to participate in GSoC 2008? What do you hope to gain by participating? ====

We believe that Xiph.Org has a wide-ranging set of projects that are both challenging and educational for the students. Furthermore, they are important/useful goals for the wider technology community, and especially users of open source software.

We believe that Xiph's mandate to develop multimedia standards and software is an important one, but we--of course--have limited resources. We hope that the results of GSoC will include the direct benefit of new software development, but also help grow the number of active participants in a long-term manner. Most of our core developers started as students, but just as many have moved on since their student days. Attracting and retaining students is essential to the health and sustainability of our project and is an important goal for all of us.

==== Did your organization participate in past GSoCs? If so, please summarize your involvement and the successes and challenges of your participation. ====

Xiph.Org was invited to participate in GSoc in both 2006 and 2007, and informally mentored Annodex-related projects as well.

In 2006, we were granted funding for 6 slots. One we weren't able to fill because our chosen students picked or were assigned to other projects.

Two were [http://code.google.com/soc/xiph/about.html successful]. One, a [http://code.google.com/soc/xiph/appinfo.html?csaid=5F9265EEC6FA0611 hardware implementation of a Theora decoder]: this project produced HDL implementation of the major decoder components, to be used with a general purpose CPU, such as the open source LEON sparc implementation. Real time playback of SD content was demonstrated using these components in combination with the proprietary Nagios cpu design. Two, [http://code.google.com/soc/xiph/appinfo.html?csaid=213E2D30F095565D implementation of OggSkeleton support] in various tools. We have maintained contact with the two successful students since the program finished. One has continued to contribute code outside the GSoC term, continuing related work.

The remaining three were unsuccessful through lack of necessary skills, health complications, insufficient motivation, or some combination of all of these.

In 2007, we were given 2 project slots. One was an extension of the hardware decoder effort from last year. The other was helping to do R&D on Xiph's next-generation audio codec, Ghost. Both were marginally successful - the students reached the minimum goals set, but little more, and did not maintain contact with Xiph.org after the program.

We enjoyed our participation over the last two years. It provided needed external input, energizing our project and improving our connections to the rest of the open source community. We think we've learnt a lot about how to mentor new and upcoming contributors, and how to best screen the applications we do receive.

==== If your organization has not previously participated in GSoC, have you applied in the past? If so, for what year(s)? ====

We have participated previously, in 2006 and 2007.

==== Who will your organization administrator be? Please include Google Account information. ====

Michael Smith has volunteered to be the primary admin this year. Google account mlrsmith@gmail.com.

==== What license(s) does your project use? ====

In general, we use a modified-BSD style license for our libraries, to enable the widest possible uses of our formats and reference implementations.

Our applications are generally GPL but LGPL or (GPL-compatible) modified BSD is also acceptable.

==== What is the URL for your ideas page? ====

http://wiki.xiph.org/index.php/Summer_of_Code

==== What is the main development mailing list or forum for your organization? ====

We don't have a single central mailing list for all of Xiph.Org. Instead, we have per-project mailing lists; of these the most active is vorbis-dev@xiph.org. A complete listing of our lists is available at:

http://lists.xiph.org/mailman/listinfo/

The primary contact of the Annodex projects is [http://lists.annodex.net/ annodex-dev@lists.annodex.net]

==== What is the main IRC channel for your organization? ====

Our main channel is #xiph on irc.freenode.net. We also have project channels: #vorbis, #theora, #icecast, #speex and #annodex are the major ones.

==== Does your organization have an application template you would like to see students use? If so, please provide it now. ====

http://wiki.xiph.org/index.php/Summer_of_Code_Applications

==== Who will be your backup organization administrator? Please include Google Account information. ====

Ralph Giles will be the backup admin if no one else volunteers. Google account giles@xiph.org.

==== Who will your mentors be? Please include Google Account information. ====

* '''Mike Smith''': google account mlrsmith@gmail.com
* '''Ralph Giles''': google account giles@xiph.org
* '''Silvia Pfeiffer''': google account silviapfeiffer1@gmail.com
* '''Christopher Montgomery''': google account xiphmont@gmail.com
* '''Timothy Terriberry''': google account tterribe@vt.edu
* '''Jean-Marc Valin''': google account jmvalin@gmail.com
* '''Arek Korbik''': google account arkadini@gmail.com
* '''Michael Dale''': google account bigmammoth@gmail.com

==== What criteria did you use to select these individuals as mentors? Please be as specific as possible. ====

We selected our mentors from the 'core' developers and contributors within Xiph. Mentors were selected based on how well they know the code area they're volunteering to mentor, how long they've been part of Xiph, how well they interact with others (particularly in terms of building community around our projects).

The majority of the mentors we've selected are core developers on the various Xiph.Org sub-projects that they've volunteered to mentor for. They have been contributing to Xiph.Org for at least several years, and have shown a persistent interest both in the software we develop, and in helping to create a community around it. We have also made sure that each mentor has sufficient time available to adequately mentor their student(s).

Mike Smith has been involved with Xiph.Org and multimedia development since 2000 and remains one of our most involved core members. He helped write major portions of the vorbis-tools suite and the icecast streaming media server. He currently works as a developer at Fluendo.com on the GStreamer multimedia framework, flumotion (a streaming media server), and other multimedia software.

Ralph Giles has been involved with Xiph.Org and multimedia development since 2000. He has contributed to tool development and the Theora video codec. He handles much of the coordination and administrative work for Xiph.Org. He mentored the successful "Hardware implementation of Theora decoding" project in GSoC 2006 and acted as an administrator.

Silvia Pfeiffer is the founder of the Annodex project and president of the Annodex Association. She is the principle author of most of the Annodex specifications, RFC 3533 and RFC 3534 describing the Ogg media format, and is heavily involved as an organizer in both the Xiph and Annodex projects.
Most recently she organized the [http://www.annodex.org/events/foms2007/ FOMS] developer summit and media recording for [http://lca2007.linux.org.au/ LCA 2007]. She helped mentor the successful "OggSkeleton support" project in GSoC 2006 and acted as an administrator during the application process.

Christopher "Monty" Montgomery is the founder of Xiph.org, architect and lead developer of the Ogg Vorbis general purpose audio compression format. He has been doing open source development under the Xiph name since 1999. His current work focuses on development of a next-generation audio codec. He helped mentor a project related to this in GSoC 2006.

Timothy Terriberry is the author of the Theora video codec specification and the author of the theora-exp implementation. He has been an active contributor since 2003. He mentored a Theora-related project in GSoC 2006.

Jan is the author of the very widely used [http://v2v.cc/~j/ffmpeg2theora/ ffmpeg2theora] transcoding tool, and maintainer of the [http://v2v.cc v2v.cc] syndication website. He has been a project contributor since 2002.

Conrad Parker is the author of the [http://www.annodex.net/software/liboggz/html/ liboggz] and [http://www.annodex.net/software/libfishsound/html/ libfishsound] convenience libraries and the [http://www.metadecks.org/software/sweep/ sweep] audio editor. He is heavily involved in the Annodex project and mentored the successful "OggSkeleton support" project in GSoC 2006.

Jean-Marc Valin is the architect and lead developer of the Speex voice codec. He has been involved in Xiph.Org since 2002. He mentored an audio codec research project in GSoC 2006.

Arek Korbik is the author of the [http://xiph.org/quicktime/ Xiph QuickTime Components]. He has been a project contributor since 2005.

Michael Dale is the author of the [http://metavid.org MetaVidWiki] project which implements many of the annodex and xiph technologies as an extension to mediaWiki.

==== What is your plan for dealing with disappearing students? ====

Our first goal will be to provide necessary support from the community such that our students do not want to suddenly vanish. We want our students to become real members of the community, with ongoing contributions. That said, we're well aware of the possibility of a student disappearing.

We intend to be reasonably strict with requiring students to keep in touch - whilst we're quite happy for them to be absent for a while if they let us know in advance, we will intend to get at least twice-weekly updates from each student.

The mentors will have primary responsibility for their students, but the admins (Mike Smith and Ralph Giles) are also going to ensure that the mentors are indeed keeping track of what their students are up to. We'll ask our students to provide means for us to get in touch beyond email, where possible - phone, etc - in case we need to get in touch urgently.

==== What is your plan for dealing with disappearing mentors? ====

Our mentors are all people who are major contributors to the Xiph projects - and have generally been contributing for many years. So, we think it's pretty unlikely that a mentor will disappear. However, we do have more mentors available than we expect to eventually have students (based on past years), so we're well able to take up the slack if a mentor becomes unavailable for any reason.

Our admins will ensure that the mentors are keeping up with the students appropriately, and should it be absolutely necessary, we will either find another appropriate mentor, or the admins (Mike and Ralph) will take over mentoring the students directly.

==== What steps will you take to encourage students to interact with your project's community before, during and after the program? ====

Xiph.Org conducts much of its development discussion and community-building on our IRC channels. We'll ask that the students be present there while they're working, where adequate network access makes that possible. We hope to make them feel that they're an important part of our community; that their contributions are really making a difference towards the goals of Xiph.

We intend to be open to their contributions - whilst we're aware that initially their work may not be of a quality sufficient to go into our core codebase immediately, we'll give them write access to our repository to work on a branch. We'll ask them to be open in discussing and designing their contributions on IRC and our mailing lists. Our application template welcomes them to come and ask us questions when they're trying to write up their application. We hope that some, or even all, of the students will continue to be part of the Xiph community after SoC concludes. For those students who have not previously contributed to open source software, we'll teach them about how important community building is for the ongoing health of such projects.

==== What will you do to ensure that your accepted students stick with the project after GSoC concludes? ====

We hope that the mentoring process and the experiences they have as part of GSoC will make the students interested in remaining part of Xiph, continuing development on the software they've been working on, and perhaps nurturing their patches towards inclusion in an actual release.

A very important part of GSoC is for us to make them active members of the community, in particular on the irc channels and the mailing lists. Past experience tells that once they have become part of that community, they will stick around for longer.

We will encourage them not to consider this just "a summer job", but as being part of a real community - and doing something that is both interesting, and useful to the wider world.

Summer of Code Mentoring

2008-03-11T20:59:31Z

Mdale: /* What criteria did you use to select these individuals as mentors? Please be as specific as possible. */

== Xiph.Org Application as a mentoring organization ==

We need to apply for consideration as a mentoring organization 2008 March 3-12. Google lists the following questions in their [http://code.google.com/soc/2008/faqs.html#0.1_org_apply faq]. Our work-in-progress answers are inline.

==== Describe your organization. ====

[http://xiph.org Xiph.Org] is an open source project and non-profit corporation dedicated to providing open and free-to-implement multimedia technology as a foundation for an interoperable, level playing field on the internet and other digital distribution networks. Over the past 8 years we have developed most of the major patent-free audio and video codecs currently in use, including Vorbis, Speex, FLAC and Theora, as well as developing the Ogg streaming format, and the Icecast streaming media server.

This year we are also coordinating projects for the [http://annodex.org Annodex association] under our umbrella. The [http://annodex.net/ Annodex project]
is developing a set of open specifications and open source software to allow the creation of hyperlinked Webs of audio and video integrated with the text-based view of the current Web. Toward this goal, Annodex has done a great deal of work developing tools, browser plugins and convenience libraries to facilitate adoption of Xiph.Org's lower-level technology. As such the two projects have largely aligned goals, but focus on different levels in the stack.

==== Why is your organization applying to participate in GSoC 2008? What do you hope to gain by participating? ====

We believe that Xiph.Org has a wide-ranging set of projects that are both challenging and educational for the students. Furthermore, they are important/useful goals for the wider technology community, and especially users of open source software.

We believe that Xiph's mandate to develop multimedia standards and software is an important one, but we--of course--have limited resources. We hope that the results of GSoC will include the direct benefit of new software development, but also help grow the number of active participants in a long-term manner. Most of our core developers started as students, but just as many have moved on since their student days. Attracting and retaining students is essential to the health and sustainability of our project and is an important goal for all of us.

==== Did your organization participate in past GSoCs? If so, please summarize your involvement and the successes and challenges of your participation. ====

Xiph.Org was invited to participate in GSoc in both 2006 and 2007, and informally mentored Annodex-related projects as well.

In 2006, we were granted funding for 6 slots. One we weren't able to fill because our chosen students picked or were assigned to other projects.

Two were [http://code.google.com/soc/xiph/about.html successful]. One, a [http://code.google.com/soc/xiph/appinfo.html?csaid=5F9265EEC6FA0611 hardware implementation of a Theora decoder]: this project produced HDL implementation of the major decoder components, to be used with a general purpose CPU, such as the open source LEON sparc implementation. Real time playback of SD content was demonstrated using these components in combination with the proprietary Nagios cpu design. Two, [http://code.google.com/soc/xiph/appinfo.html?csaid=213E2D30F095565D implementation of OggSkeleton support] in various tools. We have maintained contact with the two successful students since the program finished. One has continued to contribute code outside the GSoC term, continuing related work.

The remaining three were unsuccessful through lack of necessary skills, health complications, insufficient motivation, or some combination of all of these.

In 2007, we were given 2 project slots. One was an extension of the hardware decoder effort from last year. The other was helping to do R&D on Xiph's next-generation audio codec, Ghost. Both were marginally successful - the students reached the minimum goals set, but little more, and did not maintain contact with Xiph.org after the program.

We enjoyed our participation over the last two years. It provided needed external input, energizing our project and improving our connections to the rest of the open source community. We think we've learnt a lot about how to mentor new and upcoming contributors, and how to best screen the applications we do receive.

==== If your organization has not previously participated in GSoC, have you applied in the past? If so, for what year(s)? ====

We have participated previously, in 2006 and 2007.

==== Who will your organization administrator be? Please include Google Account information. ====

Michael Smith has volunteered to be the primary admin this year. Google account mlrsmith@gmail.com.

==== What license(s) does your project use? ====

In general, we use a modified-BSD style license for our libraries, to enable the widest possible uses of our formats and reference implementations.

Our applications are generally GPL but LGPL or (GPL-compatible) modified BSD is also acceptable.

==== What is the URL for your ideas page? ====

http://wiki.xiph.org/index.php/Summer_of_Code

==== What is the main development mailing list or forum for your organization? ====

We don't have a single central mailing list for all of Xiph.Org. Instead, we have per-project mailing lists; of these the most active is vorbis-dev@xiph.org. A complete listing of our lists is available at:

http://lists.xiph.org/mailman/listinfo/

The primary contact of the Annodex projects is [http://lists.annodex.net/ annodex-dev@lists.annodex.net]

==== What is the main IRC channel for your organization? ====

Our main channel is #xiph on irc.freenode.net. We also have project channels: #vorbis, #theora, #icecast, #speex and #annodex are the major ones.

==== Does your organization have an application template you would like to see students use? If so, please provide it now. ====

http://wiki.xiph.org/index.php/Summer_of_Code_Applications

==== Who will be your backup organization administrator? Please include Google Account information. ====

Ralph Giles will be the backup admin if no one else volunteers. Google account giles@xiph.org.

==== Who will your mentors be? Please include Google Account information. ====

* '''Mike Smith''': google account mlrsmith@gmail.com
* '''Ralph Giles''': google account giles@xiph.org
* '''Silvia Pfeiffer''': google account silviapfeiffer1@gmail.com
* '''Christopher Montgomery''': google account xiphmont@gmail.com
* '''Timothy Terriberry''': google account tterribe@vt.edu
* '''Jean-Marc Valin''': google account jmvalin@gmail.com
* '''Arek Korbik''': google account arkadini@gmail.com
* '''Michael Dale''': google account bigmammoth@gmail.com

==== What criteria did you use to select these individuals as mentors? Please be as specific as possible. ====

We selected our mentors from the 'core' developers and contributors within Xiph. Mentors were selected based on how well they know the code area they're volunteering to mentor, how long they've been part of Xiph, how well they interact with others (particularly in terms of building community around our projects).

The majority of the mentors we've selected are core developers on the various Xiph.Org sub-projects that they've volunteered to mentor for. They have been contributing to Xiph.Org for at least several years, and have shown a persistent interest both in the software we develop, and in helping to create a community around it. We have also made sure that each mentor has sufficient time available to adequately mentor their student(s).

Mike Smith has been involved with Xiph.Org and multimedia development since 2000 and remains one of our most involved core members. He helped write major portions of the vorbis-tools suite and the icecast streaming media server. He currently works as a developer at Fluendo.com on the GStreamer multimedia framework, flumotion (a streaming media server), and other multimedia software.

Ralph Giles has been involved with Xiph.Org and multimedia development since 2000. He has contributed to tool development and the Theora video codec. He handles much of the coordination and administrative work for Xiph.Org. He mentored the successful "Hardware implementation of Theora decoding" project in GSoC 2006 and acted as an administrator.

Silvia Pfeiffer is the founder of the Annodex project and president of the Annodex Association. She is the principle author of most of the Annodex specifications, RFC 3533 and RFC 3534 describing the Ogg media format, and is heavily involved as an organizer in both the Xiph and Annodex projects.
Most recently she organized the [http://www.annodex.org/events/foms2007/ FOMS] developer summit and media recording for [http://lca2007.linux.org.au/ LCA 2007]. She helped mentor the successful "OggSkeleton support" project in GSoC 2006 and acted as an administrator during the application process.

Christopher "Monty" Montgomery is the founder of Xiph.org, architect and lead developer of the Ogg Vorbis general purpose audio compression format. He has been doing open source development under the Xiph name since 1999. His current work focuses on development of a next-generation audio codec. He helped mentor a project related to this in GSoC 2006.

Timothy Terriberry is the author of the Theora video codec specification and the author of the theora-exp implementation. He has been an active contributor since 2003. He mentored a Theora-related project in GSoC 2006.

Jan is the author of the very widely used [http://v2v.cc/~j/ffmpeg2theora/ ffmpeg2theora] transcoding tool, and maintainer of the [http://v2v.cc v2v.cc] syndication website. He has been a project contributor since 2002.

Conrad Parker is the author of the [http://www.annodex.net/software/liboggz/html/ liboggz] and [http://www.annodex.net/software/libfishsound/html/ libfishsound] convenience libraries and the [http://www.metadecks.org/software/sweep/ sweep] audio editor. He is heavily involved in the Annodex project and mentored the successful "OggSkeleton support" project in GSoC 2006.

Jean-Marc Valin is the architect and lead developer of the Speex voice codec. He has been involved in Xiph.Org since 2002. He mentored an audio codec research project in GSoC 2006.

Arek Korbik is the author of the [http://xiph.org/quicktime/ Xiph QuickTime Components]. He has been a project contributor since 2005.

Michael Dale is the author of the [[http://metavid.org MetaVidWiki] project which implements many of the annodex and xiph technologies as an extension to mediaWiki.

==== What is your plan for dealing with disappearing students? ====

Our first goal will be to provide necessary support from the community such that our students do not want to suddenly vanish. We want our students to become real members of the community, with ongoing contributions. That said, we're well aware of the possibility of a student disappearing.

We intend to be reasonably strict with requiring students to keep in touch - whilst we're quite happy for them to be absent for a while if they let us know in advance, we will intend to get at least twice-weekly updates from each student.

The mentors will have primary responsibility for their students, but the admins (Mike Smith and Ralph Giles) are also going to ensure that the mentors are indeed keeping track of what their students are up to. We'll ask our students to provide means for us to get in touch beyond email, where possible - phone, etc - in case we need to get in touch urgently.

==== What is your plan for dealing with disappearing mentors? ====

Our mentors are all people who are major contributors to the Xiph projects - and have generally been contributing for many years. So, we think it's pretty unlikely that a mentor will disappear. However, we do have more mentors available than we expect to eventually have students (based on past years), so we're well able to take up the slack if a mentor becomes unavailable for any reason.

Our admins will ensure that the mentors are keeping up with the students appropriately, and should it be absolutely necessary, we will either find another appropriate mentor, or the admins (Mike and Ralph) will take over mentoring the students directly.

==== What steps will you take to encourage students to interact with your project's community before, during and after the program? ====

Xiph.Org conducts much of its development discussion and community-building on our IRC channels. We'll ask that the students be present there while they're working, where adequate network access makes that possible. We hope to make them feel that they're an important part of our community; that their contributions are really making a difference towards the goals of Xiph.

We intend to be open to their contributions - whilst we're aware that initially their work may not be of a quality sufficient to go into our core codebase immediately, we'll give them write access to our repository to work on a branch. We'll ask them to be open in discussing and designing their contributions on IRC and our mailing lists. Our application template welcomes them to come and ask us questions when they're trying to write up their application. We hope that some, or even all, of the students will continue to be part of the Xiph community after SoC concludes. For those students who have not previously contributed to open source software, we'll teach them about how important community building is for the ongoing health of such projects.

==== What will you do to ensure that your accepted students stick with the project after GSoC concludes? ====

We hope that the mentoring process and the experiences they have as part of GSoC will make the students interested in remaining part of Xiph, continuing development on the software they've been working on, and perhaps nurturing their patches towards inclusion in an actual release.

A very important part of GSoC is for us to make them active members of the community, in particular on the irc channels and the mailing lists. Past experience tells that once they have become part of that community, they will stick around for longer.

We will encourage them not to consider this just "a summer job", but as being part of a real community - and doing something that is both interesting, and useful to the wider world.

Summer of Code 2008

2008-03-11T20:56:09Z

Mdale: /* Current Ideas */

Summer of Code 2008

2008-03-04T19:07:03Z

Mdale: /* Mv_Embed: Accessibility and [re]usability: */

Summer of Code 2008

2008-03-04T18:59:07Z

Mdale:

Summer of Code 2008

2008-03-04T18:58:44Z

Mdale:

Summer of Code 2008

2008-03-04T18:57:58Z

Mdale: added mv_embed and oggPusher

OggPlayJavascriptAPI

2007-09-14T18:59:43Z

Mdale: /* insertMovieBefore */

== Introduction ==

This is a '''draft API''' for the OggPlay Firefox plugin.

We want the OggPlay plugin to support both a simple individual movie mode, and a more fully-featured playlist mode. All of the functions supported in individual movie mode are still useful in playlist mode; however additional functions also become useful.

Note that the amount of available information for an internet-cast Ogg stream depends upon the type of server providing that stream. In particular, an Apache server with [http://www.annodex.net/software/mod_annodex/index.html mod_annodex] installed provides the following information that is not available for live-streamed or raw file-streamed movies:
* length of the movie
* [[CMML]] annotations for the entire movie in advance

Furthermore, mod_annodex provides remote seeking functionality across the entire movie. Hence, OggPlay allows arbitrary seeking on mod_annodex supported movies. On the other hand, raw streams and live streams are only seekable within the region that has already been buffered by the player.

== Individual movies ==

=== OggPlayState ===

enum OggPlayState { PAUSED = 0; PLAYING = 1; FINISHED = 2 };

These are fairly self-evident: the plugin begins in PAUSED or PLAYING state depending on the settings provided through the params tags, and changes to FINISHED state when the movie finishes playback.

=== getCurrentState ===

To retrieve the state:

int <- getCurrentState()

=== pause ===

pause()

This function will convert the PLAYING or FINISHED states to PAUSED.

=== play ===

play()

This function will convert the PAUSED state to PLAYING or FINISHED depending upon the current position within the movie.

=== restart ===

restart()

This function will convert any state to PLAYING, and start the movie again from the beginning

=== getCurrentMovie ===

To retrieve the currently playing (or just played, or about to play) movie:

string URL <- getCurrentMovie()

=== setCurrentMovie ===

To set a new movie:

setCurrentMovie(string URL)

This will automatically begin playing at the beginning if the state is PLAYING or FINISHED, but will remain paused ready to play at the beginning if the state is PAUSED.

=== getPlayPosition ===

To get the current play position (in milliseconds) from the movie:

int milliseconds <- getPlayPosition()

=== setPlayPosition ===

To set the current play position (in milliseconds):

boolean success <- setPlayPosition(int milliseconds)

Note that if you set a position past the end of the movie then the result will be a play position at the end of the movie, and the player in FINISHED mode.

Note also that certain servers (e.g. plain Ogg files, no mod-annodex installed, etc.) will prevent seeking from being able to occur past the buffered portion of the file; in this case, false will be returned and the play position will be updated as far forward as possible.

=== registerCMMLCallback ===

To have the plugin call a javascript method as each CMML annotation is encountered (i.e. as movie playback reaches the point where the annotation needs to be inserted):

registerCMMLCallback(function callback(string))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

Use null if you want to deregister the callback without setting a new one.

=== retrieveAnnotations ===

To retrieve all of the CMML annotations for a movie:

boolean success <- retrieveAnnotations(function callback(string))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

This is an asynchronous call; the plugin will create a new http connection to retrieve the annotations. The callback function will be invoked with the annotation string after the annotations have been retrieved.

This function will return false if a previous attempt at retrieving annotations is still being processed.

Note that this won't return all annotations from some servers, e.g. if mod-annodex is not installed. In this case, you will still be able to retrieve CMML as each annotation is encountered using registerCMMLCallback.

=== registerEndPlayCallback ===

To have the plugin call a javascript method when the movie finishes:

registerEndPlayCallback(function callback(void))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

Use null if you want to deregister the callback without setting a new one.

=== setVolume ===

setVolume(float volume)

Use this function to set the playback volume. A value of 0.0 is equivalent to muting; a value of 1.0 is maximum volume.

=== getVolume ===

float volume <- getVolume()

Use this function to retrieve the current playback volume.

=== getWindowWidth ===

int width <- getWindowWidth()

Use this function to retrieve the width of the window in pixels (The width is determined by the Firefox render model)

=== getWindowHeight ===

int height <- getWindowHeight()

Use this function to retrieve the height of the window in pixels (The height is determined by the Firefox render model)

=== getBufferedTime ===

int milliseconds <- getBufferedTime()

Use this function to determine how many milliseconds of the current movie are buffered for display. Note that this is the amount downloaded past the currently playing point, not just the amount decoded past the currently playing point.

=== getMovieLength ===

int milliseconds <- getMovieLength()

Use this function to determine how long in milliseconds a movie is. Note that this value will not be available for some movies, depending on the server. If no value is available, then this function will return a length of -1.

=== getVersionString ===

To retrieve a human-readable version string:

string version <- getVersionString()

This string will be of the format:

"liboggplay (a.b) Annodex Media Plugin (API x.y)"

Where a.b is the liboggplay version, and x.y is the API version. Once accepted, this API will be version 1.0. Minor changes of the API can add functions but not modify existing functions.

=== getPluginVersion ===

To retrieve a version string for the plugin alone ("a.b"):

string version <- getPluginVersion()

=== getAPIVersion ===

To retrieve a version string for the Javascript interface alone ("x.y"):

string version <- getAPIVersion()

== Playlists ==

If you wish to use playlists instead of individual movies, then the above function calls still exist, with the following caveats:

* <tt>getCurrentState</tt> will not return FINISHED until the last movie in the playlist has completed playback
* <tt>getCurrentMovie</tt> retrieves the currently playing movie - i.e. the movie at the current playlist position
* <tt>setCurrentMovie</tt> sets the currently playing movie (and playback will begin from the beginning of the newly set movie, not the beginning of the playlist)
* <tt>retrieveAnnotations</tt> will retrieve the annotations for the current movie only
* <tt>registerEndPlayCallback</tt> will call back at the end of the playlist (i.e. at the end of the last movie) only. Use <tt>registerPlaylistCallback</tt> to receive notifications per movie.
* <tt>getMovieLength</tt> will retrieve the movie length for the current movie only. Use <tt>getMovieLengthAt</tt> to retrieve the length for movies in the playlist that are not currently playing.

'''Note:''' The plugin does not actually recognise separate "single movie" and "playlist" modes - instead, single movies are actually just playlists with length 1. The interface has been arranged so that the functions above "just work" for what looks like a single movie mode, but are also useful when multiple movies are inserted into the playlist.

The following additional functions are also available for manipulation of the playlist. These functions are also available when there is only one movie in the playlist, but don't provide much in the way of useful features.

=== freezePlaylistProgression ===

freezePlaylistProgression()

This function does not stop the current movie from playing, but does prevent the plugin from progressing to the next movie in the playlist. Use this and unfreezePlayPosition for "atomic" operations on the playlist.

=== unfreezePlaylistProgression ===

unfreezePlaylistProgression()

See documentation for freezePlaylistProgression.

=== registerPlaylistCallback ===

registerPlaylistCallback(function callback(void))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

Use this function to register a javascript function that will get called by the plugin at the end of each movie in the playlist - i.e. when the playlist changes tracks. The last track does '''not''' trigger a call; the end play callback, if registered, will be invoked instead.

=== getPlaylistLength ===

To retrieve the length of the playlist:

int length <- getPlaylistLength()

=== getCurrentPlaylistPosition ===

To retrieve the position in the playlist of the current movie:

int position <- getCurrentPlaylistPosition()

=== getMovieAt ===

To get the url of the movie at the specified position (0 is the first position):

string url <- getMovieAt(int position)

This function will return null if the position points to a slot outside the bounds of the playlist.

Remember that <tt>getCurrentMovie</tt> can be used to retrieve the movie at the current position.

=== setMovieAt ===

To set the url of the movie at the specified position (0 is the first position):

boolean success <- setMovieAt(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

Remember that <tt>setCurrentMovie</tt> can be used to change the currently playing movie.

=== appendMovie ===

To append a movie to the end of the playlist:

appendMovie(string url)

=== insertMovieBefore ===
'''suggested alteration''' have it be insertMovieBefore(string url, [pos])
so that the pos is optional and if missing just inserts before the current clip in the playlist

To insert a movie before a specified position in the playlist:

boolean success <- insertMovieBefore(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== removeMovieAt ===

To remove a movie from the playlist:

boolean success <- removeMovieAt(int position)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== playMovieAt ===

To start playing a movie at a specified position in the playlist:

boolean success <- playMovieAt(int position)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== playlistNext ===

To start playing the next movie in the playlist:

boolean success <- playlistNext()

This function will return false if the the current movie is the last one in the playlist.

=== playlistPrev ===

To start playing the previous movie in the playlist:

boolean success <- playlistPrev()

This function will return false if the the current movie is the first one in the playlist.

=== retrieveAnnotationsAt ===

To retrieve all of the CMML annotations for a movie at a specified position in the playlist:

boolean success <- retrieveAnnotationsAt(int position, function callback(string))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

As per retrieveAnnotations, this function is an asynchronous call and will not return any annotations if the server does not support out-of-band annotation retrieval.

This function will return false if a previous attempt at retrieving annotations is still being processed, or if the position points to a slot outside the bounds of the playlist.

=== getMovieLengthAt ===

'''This is currently unimplemented.'''

int milliseconds <- getMovieLengthAt(int position)

This function retrieves the length of the movie at the specified position in the playlist. The function will return -1 if the movie length can not be determined.

== Callback functions ==

Since Javascript functions are not first-class objects, you can't pass one directly to the plugin as a callback. You need to wrap your callback in an anonymous object with a single member, 'call':

// Use this form for callbacks with a string argument, shown as ''function callback(string)'':
plugin.registerCMMLCallback(
{
call: function(s) { yourCMLLCallback(s); }
}
);

// Use this form for callbacks with no arguments, shown as ''function callback(void)'':
plugin.registerEndPlayCallback(
{
call: function() { yourEndPlayCallback(); }
}
);

Technically, you can inline your callback handling code directly in the 'call' function, but it's much cleaner to just redirect to a stand-alone function for each callback, as shown above.

Deregistering a callback is quite simple:

plugin.registerPlaylistCallback(null);

= Suggested modifications =
==Individual Movies==
== states ==
add state LOADING and NULL or uninitialized state

== play ==
function play()
if current state is NULL set state to LOADING else if already in loading state than a second call to play will force playback of what is available.

when a user hits play internally we store a separate state that reports as LOADING but is really LOAD_TO_PLAY state which uses download rate control to predict when we should switch into playing mode. ie if the clip's duration is 60 seconds and after one second we have buffered 10 seconds of the clip we can safely immediately switch to play mode. In a different instance if after 10 seconds we have downloaded 5 seconds of the clip we should wait until we have buffered 40 seconds as it will take around 40 seconds to download the last 20 seconds of video.

if the clip is a LIVE stream then it will begin playback after a few seconds have been buffered. Controllable by:
setLiveBuffer(ms) sets the amount of the clip to buffer for a live stream.

== load ==
function load() //possible options include NOCACHE (to load from server even if its cached locally)
a function to begin loading the current clip without playing it back.

== getBufferedTime ==
Its unclear if get Buffered time gives you the milliseconds buffered from the beaning of the clip, but thats what it should do. To enable the display of a progress bar for the full clip. Ie getBufferedTime / getDuration

if playing back a live stream it could report amount buffered ahead of current playback point

==playlist==

=== loadMovieAt ===
to start downloading/buffering a clip later in playlist

=== getBufferedTimeAt ===
to get the amount Buffered for a clip in the playlist.

==Applications Preferences ==
How much disk space to use to store cached clips. Used for syncing and fast page reload on browser back. Also would be ideal if it looked for '''response headers''' that invalidate the cache. default 100megs or maybe use firefox preferences... It should uses last accessed first out cacheting.

* another point of comparison: [http://mplayerplug-in.cvs.sourceforge.net/mplayerplug-in/mplayerplug-in/DOCS/tech/javascript.txt?view=markup] (e.g. getDuration)

* suggestion: Include audio capture (and Speex encoding) in the API

OggPlayJavascriptAPI

2007-07-14T16:52:04Z

Mdale: /* getDuration */ getMovieLength

== Introduction ==

This is a '''draft API''' for the OggPlay Firefox plugin.

We want the OggPlay plugin to support both a simple individual movie mode, and a more fully-featured playlist mode. All of the functions supported in individual movie mode are still useful in playlist mode; however additional functions also become useful.

Note that the amount of available information for an internet-cast Ogg stream depends upon the type of server providing that stream. In particular, an Apache server with [http://www.annodex.net/software/mod_annodex/index.html mod_annodex] installed provides the following information that is not available for live-streamed or raw file-streamed movies:
* length of the movie
* [[CMML]] annotations for the entire movie in advance

Furthermore, mod_annodex provides remote seeking functionality across the entire movie. Hence, OggPlay allows arbitrary seeking on mod_annodex supported movies. On the other hand, raw streams and live streams are only seekable within the region that has already been buffered by the player.

== Individual movies ==

=== OggPlayState ===

enum OggPlayState { PAUSED = 0; PLAYING = 1; FINISHED = 2 };

These are fairly self-evident: the plugin begins in PAUSED or PLAYING state depending on the settings provided through the params tags, and changes to FINISHED state when the movie finishes playback.

=== getCurrentState ===

To retrieve the state:

int <- getCurrentState()

=== pause ===

pause()

This function will convert the PLAYING or FINISHED states to PAUSED.

=== play ===

play()

This function will convert the PAUSED state to PLAYING or FINISHED depending upon the current position within the movie.

=== restart ===

restart()

This function will convert any state to PLAYING, and start the movie again from the beginning

=== getCurrentMovie ===

To retrieve the currently playing (or just played, or about to play) movie:

string URL <- getCurrentMovie()

=== setCurrentMovie ===

To set a new movie:

setCurrentMovie(string URL)

This will automatically begin playing at the beginning if the state is PLAYING or FINISHED, but will remain paused ready to play at the beginning if the state is PAUSED.

=== getPlayPosition ===

To get the current play position (in milliseconds) from the movie:

int milliseconds <- getPlayPosition()

=== setPlayPosition ===

To set the current play position (in milliseconds):

boolean success <- setPlayPosition(int milliseconds)

Note that if you set a position past the end of the movie then the result will be a play position at the end of the movie, and the player in FINISHED mode.

Note also that certain servers (e.g. plain Ogg files, no mod-annodex installed, etc.) will prevent seeking from being able to occur past the buffered portion of the file; in this case, false will be returned and the play position will be updated as far forward as possible.

=== registerCMMLCallback ===

To have the plugin call a javascript method as each CMML annotation is encountered (i.e. as movie playback reaches the point where the annotation needs to be inserted):

registerCMMLCallback(function callback(string))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

Use null if you want to deregister the callback without setting a new one.

=== retrieveAnnotations ===

To retrieve all of the CMML annotations for a movie:

boolean success <- retrieveAnnotations(function callback(string))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

This is an asynchronous call; the plugin will create a new http connection to retrieve the annotations. The callback function will be invoked with the annotation string after the annotations have been retrieved.

This function will return false if a previous attempt at retrieving annotations is still being processed.

Note that this won't return all annotations from some servers, e.g. if mod-annodex is not installed. In this case, you will still be able to retrieve CMML as each annotation is encountered using registerCMMLCallback.

=== registerEndPlayCallback ===

To have the plugin call a javascript method when the movie finishes:

registerEndPlayCallback(function callback(void))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

Use null if you want to deregister the callback without setting a new one.

=== setVolume ===

setVolume(float volume)

Use this function to set the playback volume. A value of 0.0 is equivalent to muting; a value of 1.0 is maximum volume.

=== getVolume ===

float volume <- getVolume()

Use this function to retrieve the current playback volume.

=== getWindowWidth ===

int width <- getWindowWidth()

Use this function to retrieve the width of the window in pixels (The width is determined by the Firefox render model)

=== getWindowHeight ===

int height <- getWindowHeight()

Use this function to retrieve the height of the window in pixels (The height is determined by the Firefox render model)

=== getBufferedTime ===

int milliseconds <- getBufferedTime()

Use this function to determine how many milliseconds of the current movie are buffered for display. Note that this is the amount downloaded past the currently playing point, not just the amount decoded past the currently playing point.

=== getMovieLength ===

int milliseconds <- getMovieLength()

Use this function to determine how long in milliseconds a movie is. Note that this value will not be available for some movies, depending on the server. If no value is available, then this function will return a length of -1.

=== getVersionString ===

To retrieve a human-readable version string:

string version <- getVersionString()

This string will be of the format:

"liboggplay (a.b) Annodex Media Plugin (API x.y)"

Where a.b is the liboggplay version, and x.y is the API version. Once accepted, this API will be version 1.0. Minor changes of the API can add functions but not modify existing functions.

=== getPluginVersion ===

To retrieve a version string for the plugin alone ("a.b"):

string version <- getPluginVersion()

=== getAPIVersion ===

To retrieve a version string for the Javascript interface alone ("x.y"):

string version <- getAPIVersion()

== Playlists ==

If you wish to use playlists instead of individual movies, then the above function calls still exist, with the following caveats:

* <tt>getCurrentState</tt> will not return FINISHED until the last movie in the playlist has completed playback
* <tt>getCurrentMovie</tt> retrieves the currently playing movie - i.e. the movie at the current playlist position
* <tt>setCurrentMovie</tt> sets the currently playing movie (and playback will begin from the beginning of the newly set movie, not the beginning of the playlist)
* <tt>retrieveAnnotations</tt> will retrieve the annotations for the current movie only
* <tt>registerEndPlayCallback</tt> will call back at the end of the playlist (i.e. at the end of the last movie) only. Use <tt>registerPlaylistCallback</tt> to receive notifications per movie.
* <tt>getMovieLength</tt> will retrieve the movie length for the current movie only. Use <tt>getMovieLengthAt</tt> to retrieve the length for movies in the playlist that are not currently playing.

'''Note:''' The plugin does not actually recognise separate "single movie" and "playlist" modes - instead, single movies are actually just playlists with length 1. The interface has been arranged so that the functions above "just work" for what looks like a single movie mode, but are also useful when multiple movies are inserted into the playlist.

The following additional functions are also available for manipulation of the playlist. These functions are also available when there is only one movie in the playlist, but don't provide much in the way of useful features.

=== freezePlaylistProgression ===

freezePlaylistProgression()

This function does not stop the current movie from playing, but does prevent the plugin from progressing to the next movie in the playlist. Use this and unfreezePlayPosition for "atomic" operations on the playlist.

=== unfreezePlaylistProgression ===

unfreezePlaylistProgression()

See documentation for freezePlaylistProgression.

=== registerPlaylistCallback ===

registerPlaylistCallback(function callback(void))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

Use this function to register a javascript function that will get called by the plugin at the end of each movie in the playlist - i.e. when the playlist changes tracks. The last track does '''not''' trigger a call; the end play callback, if registered, will be invoked instead.

=== getPlaylistLength ===

To retrieve the length of the playlist:

int length <- getPlaylistLength()

=== getCurrentPlaylistPosition ===

To retrieve the position in the playlist of the current movie:

int position <- getCurrentPlaylistPosition()

=== getMovieAt ===

To get the url of the movie at the specified position (0 is the first position):

string url <- getMovieAt(int position)

This function will return null if the position points to a slot outside the bounds of the playlist.

Remember that <tt>getCurrentMovie</tt> can be used to retrieve the movie at the current position.

=== setMovieAt ===

To set the url of the movie at the specified position (0 is the first position):

boolean success <- setMovieAt(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

Remember that <tt>setCurrentMovie</tt> can be used to change the currently playing movie.

=== appendMovie ===

To append a movie to the end of the playlist:

appendMovie(string url)

=== insertMovieBefore ===

To insert a movie before a specified position in the playlist:

boolean success <- insertMovieBefore(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== removeMovieAt ===

To remove a movie from the playlist:

boolean success <- removeMovieAt(int position)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== playMovieAt ===

To start playing a movie at a specified position in the playlist:

boolean success <- playMovieAt(int position)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== playlistNext ===

To start playing the next movie in the playlist:

boolean success <- playlistNext()

This function will return false if the the current movie is the last one in the playlist.

=== playlistPrev ===

To start playing the previous movie in the playlist:

boolean success <- playlistPrev()

This function will return false if the the current movie is the first one in the playlist.

=== retrieveAnnotationsAt ===

To retrieve all of the CMML annotations for a movie at a specified position in the playlist:

boolean success <- retrieveAnnotationsAt(int position, function callback(string))

''See [[#Callback_functions|Callback functions]] for details on setting up a Javascript callback function.''

As per retrieveAnnotations, this function is an asynchronous call and will not return any annotations if the server does not support out-of-band annotation retrieval.

This function will return false if a previous attempt at retrieving annotations is still being processed, or if the position points to a slot outside the bounds of the playlist.

=== getMovieLengthAt ===

'''This is currently unimplemented.'''

int milliseconds <- getMovieLengthAt(int position)

This function retrieves the length of the movie at the specified position in the playlist. The function will return -1 if the movie length can not be determined.

== Callback functions ==

Since Javascript functions are not first-class objects, you can't pass one directly to the plugin as a callback. You need to wrap your callback in an anonymous object with a single member, 'call':

// Use this form for callbacks with a string argument, shown as ''function callback(string)'':
plugin.registerCMMLCallback(
{
call: function(s) { yourCMLLCallback(s); }
}
);

// Use this form for callbacks with no arguments, shown as ''function callback(void)'':
plugin.registerEndPlayCallback(
{
call: function() { yourEndPlayCallback(); }
}
);

Technically, you can inline your callback handling code directly in the 'call' function, but it's much cleaner to just redirect to a stand-alone function for each callback, as shown above.

Deregistering a callback is quite simple:

plugin.registerPlaylistCallback(null);

= Suggested modifications =
==Individual Movies==
== states ==
add state LOADING and NULL or uninitialized state

== play ==
function play()
if current state is NULL set state to LOADING else if already in loading state than a second call to play will force playback of what is available.

when a user hits play internally we store a separate state that reports as LOADING but is really LOAD_TO_PLAY state which uses download rate control to predict when we should switch into playing mode. ie if the clip's duration is 60 seconds and after one second we have buffered 10 seconds of the clip we can safely immediately switch to play mode. In a different instance if after 10 seconds we have downloaded 5 seconds of the clip we should wait until we have buffered 40 seconds as it will take around 40 seconds to download the last 20 seconds of video.

if the clip is a LIVE stream then it will begin playback after a few seconds have been buffered. Controllable by:
setLiveBuffer(ms) sets the amount of the clip to buffer for a live stream.

== load ==
function load() //possible options include NOCACHE (to load from server even if its cached locally)
a function to begin loading the current clip without playing it back.

== getBufferedTime ==
Its unclear if get Buffered time gives you the milliseconds buffered from the beaning of the clip, but thats what it should do. To enable the display of a progress bar for the full clip. Ie getBufferedTime / getDuration

if playing back a live stream it could report amount buffered ahead of current playback point

==playlist==

=== loadMovieAt ===
to start downloading/buffering a clip later in playlist

=== getBufferedTimeAt ===
to get the amount Buffered for a clip in the playlist.

==Applications Preferences ==
How much disk space to use to store cached clips. Used for syncing and fast page reload on browser back. Also would be ideal if it looked for '''response headers''' that invalidate the cache. default 100megs or maybe use firefox preferences... It should uses last accessed first out cacheting.

* another point of comparison: [http://mplayerplug-in.cvs.sourceforge.net/mplayerplug-in/mplayerplug-in/DOCS/tech/javascript.txt?view=markup] (e.g. getDuration)

* suggestion: Include audio capture (and Speex encoding) in the API

OggPlayJavascriptAPI

2007-05-18T10:36:59Z

Mdale: /* play */

== Introduction ==

This is a '''draft API''' for the OggPlay Firefox plugin.

We want the OggPlay plugin to support both a simple individual movie mode, and a more fully-featured playlist mode. All of the functions supported in individual movie mode are still useful in playlist mode; however additional functions also become useful.

Note that the amount of available information for an internet-cast Ogg stream depends upon the type of server providing that stream. In particular, an apache server with mod-annodex installed provides the following information that is not available for live-streamed or raw file-streamed movies:
* length of the movie
* CMML annotations for the entire movie in advance

Furthermore, mod-annodex provides remote seeking functionality across the entire movie. Hence, Oggplay allows arbitrary seeking on mod-annodex supported movies. On the other hand, raw streams and live streams are only seekable within the region that has already been buffered by the player.

== Individual movies ==

=== OggPlayState ===

enum OggPlayState { PAUSED = 0; PLAYING = 1; FINISHED = 2 };

These are fairly self-evident: the plugin begins in PAUSED or PLAYING state depending on the settings provided through the params tags, and changes to FINISHED state when the movie finishes playback.

=== getCurrentState ===

To retrieve the state:

int <- getCurrentState()

=== pause ===

pause()

This function will convert the PLAYING or FINISHED states to PAUSED.

=== play ===

play()

This function will convert the PAUSED state to PLAYING or FINISHED depending upon the current position within the movie.

=== restart ===

restart()

This function will convert any state to PLAYING, and start the movie again from the beginning

=== getCurrentMovie ===

To retrieve the currently playing (or just played, or about to play) movie:

string URL <- getCurrentMovie()

=== setCurrentMovie ===

To set a new movie:

setCurrentMovie(string URL)

This will automatically begin playing at the beginning if the state is PLAYING or FINISHED, but will remain paused ready to play at the beginning if the state is PAUSED.

=== getPlayPosition ===

To get the current play position (in milliseconds) from the movie:

int milliseconds <- getPlayPosition()

=== setPlayPosition ===

To set the current play position (in milliseconds):

boolean success <- setPlayPosition(int milliseconds)

Note that if you set a position past the end of the movie then the result will be a play position at the end of the movie, and the player in FINISHED mode.

Note also that certain servers (e.g. plain Ogg files, no mod-annodex installed, etc.) will prevent seeking from being able to occur past the buffered portion of the file; in this case, false will be returned and the play position will be updated as far forward as possible.

=== registerCMMLCallback ===

To have the plugin call a javascript method as each CMML annotation is encountered (i.e. as movie playback reaches the point where the annotation needs to be inserted):

registerCMMLCallback(function callback)

Use null if you want to deregister the callback without setting a new one.

=== retrieveAnnotations ===

To retrieve all of the CMML annotations for a movie:

string CMML <- retrieveAnnotations()

Note that this won't return all annotations from some servers, e.g. if mod-annodex is not installed. In this case, you will still be able to retrieve CMML as each annotation is encountered using registerCMMLCallback.

=== registerEndPlayCallback ===

To have the plugin call a javascript method when the movie finishes:

registerEndPlayCallback(function callback)

Use null if you want to deregister the callback without setting a new one.

=== setVolume ===

setVolume(float volume)

Use this function to set the playback volume. A value of 0.0 is equivalent to muting; a value of 1.0 is maximum volume.

=== getVolume ===

float volume <- getVolume()

Use this function to retrieve the current playback volume.

=== getWindowWidth ===

int width <- getWindowWidth()

Use this function to retrieve the width of the window in pixels (The width is determined by the Firefox render model)

=== getWindowHeight ===

int height <- getWindowHeight()

Use this function to retrieve the height of the window in pixels (The height is determined by the Firefox render model)

=== getBufferedTime ===

int milliseconds <- getBufferedTime()

Use this function to determine how many milliseconds of the current movie are buffered for display. Note that this is the amount downloaded past the currently playing point, not just the amount decoded past the currently playing point.

=== getMovieLength ===

int milliseconds <- getMovieLength()

Use this function to determine how long in milliseconds a movie is. Note that this value will not be available for some movies, depending on the server. If no value is available, then this function will return a length of -1.

=== getVersionString ===

To retrieve a version string:

string version <- getVersionString()

This string will be of the format:

"liboggplay (a.b) Annodex Media Plugin (API x.y)"

Where a.b is the liboggplay version, and x.y is the API version. Once accepted, this API will be version 1.0. Minor changes of the API can add functions but not modify existing functions.

== Playlists ==

If you wish to use playlists instead of individual movies, then the above function calls still exist, with the following caveats:

* <tt>getCurrentState</tt> will not return FINISHED until the last movie in the playlist has completed playback
* <tt>restart</tt> will start from the beginning of the playlist, not the beginning of the current movie
* <tt>getCurrentMovie</tt> retrieves the currently playing movie - i.e. the movie at the current playlist position
* <tt>setCurrentMovie</tt> sets the currently playing movie (and playback will begin from the beginning of the newly set movie, not the beginning of the playlist)
* <tt>getPlayPosition</tt> and <tt>setPlayPosition</tt> operate on the playlist as a whole - i.e. if a playlist consists of a 5 second, a 7 second and a 4 second movie, then setPlayPosition(6000) will start playing from 1 second into the 2nd movie. In situations where the size of movies not yet encountered can not be determined (e.g. if mod-annodex is not installed on the server), then false will be returned if <tt>setPlayPosition</tt> requests a position past the furthest encountered position, and the furthest encountered position will be set.
* <tt>retrieveAnnotations</tt> will retrieve the annotations for the current movie only
* <tt>registerEODCallback</tt> will call back at the end of the playlist (i.e. at the end of the last movie) only. Use <tt>registerPlaylistCallback</tt> to recieve notifications per movie.
* <tt>getMovieLength</tt> will retrieve the movie length for the current movie only. Use <tt>getMovieLengthAt</tt> to retrieve he movie length for movies in the playlist that are not currently playing.

'''Note:''' The plugin does not actually recognise separate "single movie" and "playlist" modes - instead, single movies are actually just playlists with length 1. The interface has been arranged so that the functions above "just work" for what looks like a single movie mode, but are also useful when multiple movies are inserted into the playlist.

The following additional functions are also available for manipulation of the playlist. These functions are also available when there is only one movie in the playlist, but don't provide much in the way of useful features.

=== freezePlaylistProgression ===

freezePlaylistProgression()

This function does not stop the current movie from playing, but does prevent the plugin from progressing to the next movie in the playlist. Use this and unfreezePlayPosition for "atomic" operations on the playlist.

=== unfreezePlaylistProgression ===

unfreezePlaylistProgression()

See documentation for freezePlaylistProgression.

=== registerPlaylistCallback ===

registerPlaylistCallback(function callback)

Use this function to register a javascript function that will get called by the plugin at the end of each movie in the playlist - i.e. when the playlist changes tracks.

'''Note:''' the last track will also trigger a call. In the following circumstance

// there are 3 movies in the playlist
registerPlaylistCallback(callbackA)
registerEODCallback(callbackB)

Then <tt>callbackA</tt> will be called 3 times, and <tt>callbackB</tt> will be called once

=== getPlaylistLength ===

To retrieve the length of the playlist:

int length <- getPlaylistLength()

=== getCurrentPlaylistPosition ===

To retrieve the position in the playlist of the current movie:

int position <- getCurrentPlaylistPosition()

=== getMovieAt ===

To get the url of the movie at the specified position (0 is the first position):

string url <- getMovieAt(int position)

This function will return null if the position points to a slot outside the bounds of the playlist.

Remember that <tt>getCurrentMovie</tt> can be used to retrieve the movie at the current position.

=== setMovieAt ===

To set the url of the movie at the specified position (0 is the first position):

boolean success <- setMovieAt(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

Remember that <tt>setCurrentMovie</tt> can be used to change the currently playing movie.

=== appendMovie ===

To append a movie to the end of the playlist:

appendMovie(string url)

=== insertMovieBefore ===

To insert a movie before a specified position in the playlist:

boolean success <- insertMovieBefore(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== getPlayPositionWithinMovie ===

int milliseconds <- getPlayPositionWithinMovie()

This function retrieves the play position in milliseconds relative to the beginning of the current movie.

Use <tt>getPlayPosition</tt> to retrieve the play position relative to the beginning of the playlist.

=== setPlayPositionWithinMovie ===

boolean success <- setPlayPositionWithinMovie(int milliseconds)

This function sets the play position in milliseconds relative to the beginning of the current movie.

Use <tt>setPlayPosition</tt> to set the play position relative to the beginning of the playlist.

=== retrieveAnnotationsAt ===

string CMML <- retrieveAnnotationsAt(int position)

This function retrieves the CMML annotations from the movie at the specified position in the playlist. The function will return an empty string in the following cases:

* the movie at this position has no annotation
* the movie at this position is being served from a server that does not support out-of-band annotation retrieval
* the position is not a valid position (i.e. is outside the bounds of the playlist)

=== getMovieLengthAt ===

int milliseconds <- getMovieLengthAt(int position)

This function retrieves the length of the movie at the specified position in the playlist. The function will return -1 if the movie length can not be determined.

= Suggested modifications =
==Individual Movies==
== states ==
add state LOADING and NULL or uninitialized state

== play ==
function play()
if current state is NULL set state to LOADING else if already in loading state than a second call to play will force playback of what is available.

when a user hits play internally we store a separate state that reports as LOADING but is really LOAD_TO_PLAY state which uses download rate control to predict when we should switch into playing mode. ie if the clip's duration is 60 seconds and after one second we have buffered 10 seconds of the clip we can safely immediately switch to play mode. In diffrent instance if after 10 seconds we have downloaded 5 seconds of the clip we should wait until we have buffered 40 seconds as it will take around 40 seconds to download the last 20 seconds of video.

if the clip is a LIVE stream then it will begin playback after a few seconds have been buffered. Controllable by:
setLiveBuffer(ms) sets the amount of the clip to buffer for a live stream.

== load ==
function load() //possible options include NOCACHE (to load from server even if its cached locally)
a function to begin loading the current clip without playing it back.

== getDuration ==
get the clips duration

== getBufferedTime ==
Its unclear if get Buffered time gives you the milliseconds buffered from the beaning of the clip, but thats what it should do. To enable the display of a progress bar for the full clip. Ie getBufferedTime / getDuration

if playing back a live stream it could report amount buffered ahead of current playback point

==playlist==

=== loadMovieAt ===
to start downloading/buffering a clip later in playlist

=== getBufferedTimeAt ===
to get the amount Buffered for a clip in the playlist.

==Applications Preferences ==
How much disk space to use to store cached clips. Used for syncing and fast page reload on browser back. Also would be ideal if it looked for '''response headers''' that invalidate the cache. default 100megs or maybe use firefox preferences... It should uses last accessed first out cacheting.

* another point of comparison: [http://mplayerplug-in.cvs.sourceforge.net/mplayerplug-in/mplayerplug-in/DOCS/tech/javascript.txt?view=markup] (e.g. getDuration)

OggPlayJavascriptAPI

2007-05-18T10:32:47Z

Mdale: /* getBufferedTimeAt */

== Introduction ==

This is a '''draft API''' for the OggPlay Firefox plugin.

We want the OggPlay plugin to support both a simple individual movie mode, and a more fully-featured playlist mode. All of the functions supported in individual movie mode are still useful in playlist mode; however additional functions also become useful.

Note that the amount of available information for an internet-cast Ogg stream depends upon the type of server providing that stream. In particular, an apache server with mod-annodex installed provides the following information that is not available for live-streamed or raw file-streamed movies:
* length of the movie
* CMML annotations for the entire movie in advance

Furthermore, mod-annodex provides remote seeking functionality across the entire movie. Hence, Oggplay allows arbitrary seeking on mod-annodex supported movies. On the other hand, raw streams and live streams are only seekable within the region that has already been buffered by the player.

== Individual movies ==

=== OggPlayState ===

enum OggPlayState { PAUSED = 0; PLAYING = 1; FINISHED = 2 };

These are fairly self-evident: the plugin begins in PAUSED or PLAYING state depending on the settings provided through the params tags, and changes to FINISHED state when the movie finishes playback.

=== getCurrentState ===

To retrieve the state:

int <- getCurrentState()

=== pause ===

pause()

This function will convert the PLAYING or FINISHED states to PAUSED.

=== play ===

play()

This function will convert the PAUSED state to PLAYING or FINISHED depending upon the current position within the movie.

=== restart ===

restart()

This function will convert any state to PLAYING, and start the movie again from the beginning

=== getCurrentMovie ===

To retrieve the currently playing (or just played, or about to play) movie:

string URL <- getCurrentMovie()

=== setCurrentMovie ===

To set a new movie:

setCurrentMovie(string URL)

This will automatically begin playing at the beginning if the state is PLAYING or FINISHED, but will remain paused ready to play at the beginning if the state is PAUSED.

=== getPlayPosition ===

To get the current play position (in milliseconds) from the movie:

int milliseconds <- getPlayPosition()

=== setPlayPosition ===

To set the current play position (in milliseconds):

boolean success <- setPlayPosition(int milliseconds)

Note that if you set a position past the end of the movie then the result will be a play position at the end of the movie, and the player in FINISHED mode.

Note also that certain servers (e.g. plain Ogg files, no mod-annodex installed, etc.) will prevent seeking from being able to occur past the buffered portion of the file; in this case, false will be returned and the play position will be updated as far forward as possible.

=== registerCMMLCallback ===

To have the plugin call a javascript method as each CMML annotation is encountered (i.e. as movie playback reaches the point where the annotation needs to be inserted):

registerCMMLCallback(function callback)

Use null if you want to deregister the callback without setting a new one.

=== retrieveAnnotations ===

To retrieve all of the CMML annotations for a movie:

string CMML <- retrieveAnnotations()

Note that this won't return all annotations from some servers, e.g. if mod-annodex is not installed. In this case, you will still be able to retrieve CMML as each annotation is encountered using registerCMMLCallback.

=== registerEndPlayCallback ===

To have the plugin call a javascript method when the movie finishes:

registerEndPlayCallback(function callback)

Use null if you want to deregister the callback without setting a new one.

=== setVolume ===

setVolume(float volume)

Use this function to set the playback volume. A value of 0.0 is equivalent to muting; a value of 1.0 is maximum volume.

=== getVolume ===

float volume <- getVolume()

Use this function to retrieve the current playback volume.

=== getWindowWidth ===

int width <- getWindowWidth()

Use this function to retrieve the width of the window in pixels (The width is determined by the Firefox render model)

=== getWindowHeight ===

int height <- getWindowHeight()

Use this function to retrieve the height of the window in pixels (The height is determined by the Firefox render model)

=== getBufferedTime ===

int milliseconds <- getBufferedTime()

Use this function to determine how many milliseconds of the current movie are buffered for display. Note that this is the amount downloaded past the currently playing point, not just the amount decoded past the currently playing point.

=== getMovieLength ===

int milliseconds <- getMovieLength()

Use this function to determine how long in milliseconds a movie is. Note that this value will not be available for some movies, depending on the server. If no value is available, then this function will return a length of -1.

=== getVersionString ===

To retrieve a version string:

string version <- getVersionString()

This string will be of the format:

"liboggplay (a.b) Annodex Media Plugin (API x.y)"

Where a.b is the liboggplay version, and x.y is the API version. Once accepted, this API will be version 1.0. Minor changes of the API can add functions but not modify existing functions.

== Playlists ==

If you wish to use playlists instead of individual movies, then the above function calls still exist, with the following caveats:

* <tt>getCurrentState</tt> will not return FINISHED until the last movie in the playlist has completed playback
* <tt>restart</tt> will start from the beginning of the playlist, not the beginning of the current movie
* <tt>getCurrentMovie</tt> retrieves the currently playing movie - i.e. the movie at the current playlist position
* <tt>setCurrentMovie</tt> sets the currently playing movie (and playback will begin from the beginning of the newly set movie, not the beginning of the playlist)
* <tt>getPlayPosition</tt> and <tt>setPlayPosition</tt> operate on the playlist as a whole - i.e. if a playlist consists of a 5 second, a 7 second and a 4 second movie, then setPlayPosition(6000) will start playing from 1 second into the 2nd movie. In situations where the size of movies not yet encountered can not be determined (e.g. if mod-annodex is not installed on the server), then false will be returned if <tt>setPlayPosition</tt> requests a position past the furthest encountered position, and the furthest encountered position will be set.
* <tt>retrieveAnnotations</tt> will retrieve the annotations for the current movie only
* <tt>registerEODCallback</tt> will call back at the end of the playlist (i.e. at the end of the last movie) only. Use <tt>registerPlaylistCallback</tt> to recieve notifications per movie.
* <tt>getMovieLength</tt> will retrieve the movie length for the current movie only. Use <tt>getMovieLengthAt</tt> to retrieve he movie length for movies in the playlist that are not currently playing.

'''Note:''' The plugin does not actually recognise separate "single movie" and "playlist" modes - instead, single movies are actually just playlists with length 1. The interface has been arranged so that the functions above "just work" for what looks like a single movie mode, but are also useful when multiple movies are inserted into the playlist.

The following additional functions are also available for manipulation of the playlist. These functions are also available when there is only one movie in the playlist, but don't provide much in the way of useful features.

=== freezePlaylistProgression ===

freezePlaylistProgression()

This function does not stop the current movie from playing, but does prevent the plugin from progressing to the next movie in the playlist. Use this and unfreezePlayPosition for "atomic" operations on the playlist.

=== unfreezePlaylistProgression ===

unfreezePlaylistProgression()

See documentation for freezePlaylistProgression.

=== registerPlaylistCallback ===

registerPlaylistCallback(function callback)

Use this function to register a javascript function that will get called by the plugin at the end of each movie in the playlist - i.e. when the playlist changes tracks.

'''Note:''' the last track will also trigger a call. In the following circumstance

// there are 3 movies in the playlist
registerPlaylistCallback(callbackA)
registerEODCallback(callbackB)

Then <tt>callbackA</tt> will be called 3 times, and <tt>callbackB</tt> will be called once

=== getPlaylistLength ===

To retrieve the length of the playlist:

int length <- getPlaylistLength()

=== getCurrentPlaylistPosition ===

To retrieve the position in the playlist of the current movie:

int position <- getCurrentPlaylistPosition()

=== getMovieAt ===

To get the url of the movie at the specified position (0 is the first position):

string url <- getMovieAt(int position)

This function will return null if the position points to a slot outside the bounds of the playlist.

Remember that <tt>getCurrentMovie</tt> can be used to retrieve the movie at the current position.

=== setMovieAt ===

To set the url of the movie at the specified position (0 is the first position):

boolean success <- setMovieAt(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

Remember that <tt>setCurrentMovie</tt> can be used to change the currently playing movie.

=== appendMovie ===

To append a movie to the end of the playlist:

appendMovie(string url)

=== insertMovieBefore ===

To insert a movie before a specified position in the playlist:

boolean success <- insertMovieBefore(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== getPlayPositionWithinMovie ===

int milliseconds <- getPlayPositionWithinMovie()

This function retrieves the play position in milliseconds relative to the beginning of the current movie.

Use <tt>getPlayPosition</tt> to retrieve the play position relative to the beginning of the playlist.

=== setPlayPositionWithinMovie ===

boolean success <- setPlayPositionWithinMovie(int milliseconds)

This function sets the play position in milliseconds relative to the beginning of the current movie.

Use <tt>setPlayPosition</tt> to set the play position relative to the beginning of the playlist.

=== retrieveAnnotationsAt ===

string CMML <- retrieveAnnotationsAt(int position)

This function retrieves the CMML annotations from the movie at the specified position in the playlist. The function will return an empty string in the following cases:

* the movie at this position has no annotation
* the movie at this position is being served from a server that does not support out-of-band annotation retrieval
* the position is not a valid position (i.e. is outside the bounds of the playlist)

=== getMovieLengthAt ===

int milliseconds <- getMovieLengthAt(int position)

This function retrieves the length of the movie at the specified position in the playlist. The function will return -1 if the movie length can not be determined.

= Suggested modifications =
==Individual Movies==
== states ==
add state LOADING and NULL or uninitialized state

== play ==
function play()
if current state is NULL set state to LOADING else if already in loading state than a second call to play will force playback of what is available.

when in a LOADING state after hitting play the plug in should use download rate control to predict when we should switch into playing mode. ie if the clip's duration is 60 seconds and after one second we have buffered 10 seconds of the clip we can safely immediately switch to play mode. If after 10 seconds we have downloaded 5 seconds of the clip we should wait until we have buffered 40 seconds as it will take around 40 seconds to download the last 20 seconds of video.

if the clip is a LIVE stream then it will begin playback after a few seconds have been buffered. Controllable by:
setLiveBuffer(ms) sets the amount of the clip to buffer for a live stream.

== load ==
function load() //possible options include NOCACHE (to load from server even if its cached locally)
a function to begin loading the current clip without playing it back.

== getDuration ==
get the clips duration

== getBufferedTime ==
Its unclear if get Buffered time gives you the milliseconds buffered from the beaning of the clip, but thats what it should do. To enable the display of a progress bar for the full clip. Ie getBufferedTime / getDuration

if playing back a live stream it could report amount buffered ahead of current playback point

==playlist==

=== loadMovieAt ===
to start downloading/buffering a clip later in playlist

=== getBufferedTimeAt ===
to get the amount Buffered for a clip in the playlist.

==Applications Preferences ==
How much disk space to use to store cached clips. Used for syncing and fast page reload on browser back. Also would be ideal if it looked for '''response headers''' that invalidate the cache. default 100megs or maybe use firefox preferences... It should uses last accessed first out cacheting.

* another point of comparison: [http://mplayerplug-in.cvs.sourceforge.net/mplayerplug-in/mplayerplug-in/DOCS/tech/javascript.txt?view=markup] (e.g. getDuration)

OggPlayJavascriptAPI

2007-05-18T10:32:10Z

Mdale: added some suggestions

== Introduction ==

This is a '''draft API''' for the OggPlay Firefox plugin.

We want the OggPlay plugin to support both a simple individual movie mode, and a more fully-featured playlist mode. All of the functions supported in individual movie mode are still useful in playlist mode; however additional functions also become useful.

Note that the amount of available information for an internet-cast Ogg stream depends upon the type of server providing that stream. In particular, an apache server with mod-annodex installed provides the following information that is not available for live-streamed or raw file-streamed movies:
* length of the movie
* CMML annotations for the entire movie in advance

Furthermore, mod-annodex provides remote seeking functionality across the entire movie. Hence, Oggplay allows arbitrary seeking on mod-annodex supported movies. On the other hand, raw streams and live streams are only seekable within the region that has already been buffered by the player.

== Individual movies ==

=== OggPlayState ===

enum OggPlayState { PAUSED = 0; PLAYING = 1; FINISHED = 2 };

These are fairly self-evident: the plugin begins in PAUSED or PLAYING state depending on the settings provided through the params tags, and changes to FINISHED state when the movie finishes playback.

=== getCurrentState ===

To retrieve the state:

int <- getCurrentState()

=== pause ===

pause()

This function will convert the PLAYING or FINISHED states to PAUSED.

=== play ===

play()

This function will convert the PAUSED state to PLAYING or FINISHED depending upon the current position within the movie.

=== restart ===

restart()

This function will convert any state to PLAYING, and start the movie again from the beginning

=== getCurrentMovie ===

To retrieve the currently playing (or just played, or about to play) movie:

string URL <- getCurrentMovie()

=== setCurrentMovie ===

To set a new movie:

setCurrentMovie(string URL)

This will automatically begin playing at the beginning if the state is PLAYING or FINISHED, but will remain paused ready to play at the beginning if the state is PAUSED.

=== getPlayPosition ===

To get the current play position (in milliseconds) from the movie:

int milliseconds <- getPlayPosition()

=== setPlayPosition ===

To set the current play position (in milliseconds):

boolean success <- setPlayPosition(int milliseconds)

Note that if you set a position past the end of the movie then the result will be a play position at the end of the movie, and the player in FINISHED mode.

Note also that certain servers (e.g. plain Ogg files, no mod-annodex installed, etc.) will prevent seeking from being able to occur past the buffered portion of the file; in this case, false will be returned and the play position will be updated as far forward as possible.

=== registerCMMLCallback ===

To have the plugin call a javascript method as each CMML annotation is encountered (i.e. as movie playback reaches the point where the annotation needs to be inserted):

registerCMMLCallback(function callback)

Use null if you want to deregister the callback without setting a new one.

=== retrieveAnnotations ===

To retrieve all of the CMML annotations for a movie:

string CMML <- retrieveAnnotations()

Note that this won't return all annotations from some servers, e.g. if mod-annodex is not installed. In this case, you will still be able to retrieve CMML as each annotation is encountered using registerCMMLCallback.

=== registerEndPlayCallback ===

To have the plugin call a javascript method when the movie finishes:

registerEndPlayCallback(function callback)

Use null if you want to deregister the callback without setting a new one.

=== setVolume ===

setVolume(float volume)

Use this function to set the playback volume. A value of 0.0 is equivalent to muting; a value of 1.0 is maximum volume.

=== getVolume ===

float volume <- getVolume()

Use this function to retrieve the current playback volume.

=== getWindowWidth ===

int width <- getWindowWidth()

Use this function to retrieve the width of the window in pixels (The width is determined by the Firefox render model)

=== getWindowHeight ===

int height <- getWindowHeight()

Use this function to retrieve the height of the window in pixels (The height is determined by the Firefox render model)

=== getBufferedTime ===

int milliseconds <- getBufferedTime()

Use this function to determine how many milliseconds of the current movie are buffered for display. Note that this is the amount downloaded past the currently playing point, not just the amount decoded past the currently playing point.

=== getMovieLength ===

int milliseconds <- getMovieLength()

Use this function to determine how long in milliseconds a movie is. Note that this value will not be available for some movies, depending on the server. If no value is available, then this function will return a length of -1.

=== getVersionString ===

To retrieve a version string:

string version <- getVersionString()

This string will be of the format:

"liboggplay (a.b) Annodex Media Plugin (API x.y)"

Where a.b is the liboggplay version, and x.y is the API version. Once accepted, this API will be version 1.0. Minor changes of the API can add functions but not modify existing functions.

== Playlists ==

If you wish to use playlists instead of individual movies, then the above function calls still exist, with the following caveats:

* <tt>getCurrentState</tt> will not return FINISHED until the last movie in the playlist has completed playback
* <tt>restart</tt> will start from the beginning of the playlist, not the beginning of the current movie
* <tt>getCurrentMovie</tt> retrieves the currently playing movie - i.e. the movie at the current playlist position
* <tt>setCurrentMovie</tt> sets the currently playing movie (and playback will begin from the beginning of the newly set movie, not the beginning of the playlist)
* <tt>getPlayPosition</tt> and <tt>setPlayPosition</tt> operate on the playlist as a whole - i.e. if a playlist consists of a 5 second, a 7 second and a 4 second movie, then setPlayPosition(6000) will start playing from 1 second into the 2nd movie. In situations where the size of movies not yet encountered can not be determined (e.g. if mod-annodex is not installed on the server), then false will be returned if <tt>setPlayPosition</tt> requests a position past the furthest encountered position, and the furthest encountered position will be set.
* <tt>retrieveAnnotations</tt> will retrieve the annotations for the current movie only
* <tt>registerEODCallback</tt> will call back at the end of the playlist (i.e. at the end of the last movie) only. Use <tt>registerPlaylistCallback</tt> to recieve notifications per movie.
* <tt>getMovieLength</tt> will retrieve the movie length for the current movie only. Use <tt>getMovieLengthAt</tt> to retrieve he movie length for movies in the playlist that are not currently playing.

'''Note:''' The plugin does not actually recognise separate "single movie" and "playlist" modes - instead, single movies are actually just playlists with length 1. The interface has been arranged so that the functions above "just work" for what looks like a single movie mode, but are also useful when multiple movies are inserted into the playlist.

The following additional functions are also available for manipulation of the playlist. These functions are also available when there is only one movie in the playlist, but don't provide much in the way of useful features.

=== freezePlaylistProgression ===

freezePlaylistProgression()

This function does not stop the current movie from playing, but does prevent the plugin from progressing to the next movie in the playlist. Use this and unfreezePlayPosition for "atomic" operations on the playlist.

=== unfreezePlaylistProgression ===

unfreezePlaylistProgression()

See documentation for freezePlaylistProgression.

=== registerPlaylistCallback ===

registerPlaylistCallback(function callback)

Use this function to register a javascript function that will get called by the plugin at the end of each movie in the playlist - i.e. when the playlist changes tracks.

'''Note:''' the last track will also trigger a call. In the following circumstance

// there are 3 movies in the playlist
registerPlaylistCallback(callbackA)
registerEODCallback(callbackB)

Then <tt>callbackA</tt> will be called 3 times, and <tt>callbackB</tt> will be called once

=== getPlaylistLength ===

To retrieve the length of the playlist:

int length <- getPlaylistLength()

=== getCurrentPlaylistPosition ===

To retrieve the position in the playlist of the current movie:

int position <- getCurrentPlaylistPosition()

=== getMovieAt ===

To get the url of the movie at the specified position (0 is the first position):

string url <- getMovieAt(int position)

This function will return null if the position points to a slot outside the bounds of the playlist.

Remember that <tt>getCurrentMovie</tt> can be used to retrieve the movie at the current position.

=== setMovieAt ===

To set the url of the movie at the specified position (0 is the first position):

boolean success <- setMovieAt(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

Remember that <tt>setCurrentMovie</tt> can be used to change the currently playing movie.

=== appendMovie ===

To append a movie to the end of the playlist:

appendMovie(string url)

=== insertMovieBefore ===

To insert a movie before a specified position in the playlist:

boolean success <- insertMovieBefore(int position, string url)

This function will return false if the position points to a slot outside the bounds of the playlist.

=== getPlayPositionWithinMovie ===

int milliseconds <- getPlayPositionWithinMovie()

This function retrieves the play position in milliseconds relative to the beginning of the current movie.

Use <tt>getPlayPosition</tt> to retrieve the play position relative to the beginning of the playlist.

=== setPlayPositionWithinMovie ===

boolean success <- setPlayPositionWithinMovie(int milliseconds)

This function sets the play position in milliseconds relative to the beginning of the current movie.

Use <tt>setPlayPosition</tt> to set the play position relative to the beginning of the playlist.

=== retrieveAnnotationsAt ===

string CMML <- retrieveAnnotationsAt(int position)

This function retrieves the CMML annotations from the movie at the specified position in the playlist. The function will return an empty string in the following cases:

* the movie at this position has no annotation
* the movie at this position is being served from a server that does not support out-of-band annotation retrieval
* the position is not a valid position (i.e. is outside the bounds of the playlist)

=== getMovieLengthAt ===

int milliseconds <- getMovieLengthAt(int position)

This function retrieves the length of the movie at the specified position in the playlist. The function will return -1 if the movie length can not be determined.

= Suggested modifications =
==Individual Movies==
== states ==
add state LOADING and NULL or uninitialized state

== play ==
function play()
if current state is NULL set state to LOADING else if already in loading state than a second call to play will force playback of what is available.

when in a LOADING state after hitting play the plug in should use download rate control to predict when we should switch into playing mode. ie if the clip's duration is 60 seconds and after one second we have buffered 10 seconds of the clip we can safely immediately switch to play mode. If after 10 seconds we have downloaded 5 seconds of the clip we should wait until we have buffered 40 seconds as it will take around 40 seconds to download the last 20 seconds of video.

if the clip is a LIVE stream then it will begin playback after a few seconds have been buffered. Controllable by:
setLiveBuffer(ms) sets the amount of the clip to buffer for a live stream.

== load ==
function load() //possible options include NOCACHE (to load from server even if its cached locally)
a function to begin loading the current clip without playing it back.

== getDuration ==
get the clips duration

== getBufferedTime ==
Its unclear if get Buffered time gives you the milliseconds buffered from the beaning of the clip, but thats what it should do. To enable the display of a progress bar for the full clip. Ie getBufferedTime / getDuration

if playing back a live stream it could report amount buffered ahead of current playback point

==playlist==

=== loadMovieAt ===
to start downloading/buffering a clip later in playlist

=== getBufferedTimeAt ===
to get the amount which a clip for a clip in the playlist.

==Applications Preferences ==
How much disk space to use to store cached clips. Used for syncing and fast page reload on browser back. Also would be ideal if it looked for '''response headers''' that invalidate the cache. default 100megs or maybe use firefox preferences... It should uses last accessed first out cacheting.

* another point of comparison: [http://mplayerplug-in.cvs.sourceforge.net/mplayerplug-in/mplayerplug-in/DOCS/tech/javascript.txt?view=markup] (e.g. getDuration)

Summer of Code 2008

2007-03-13T18:10:14Z

Mdale: added CMS integration

== Current Ideas ==

This is our ideas page for [http://code.google.com/soc/ Google Summer of Code] projects with [http://xiph.org Xiph.org] and [http://annodex.net/ Annodex]. The two projects are participating jointly this year under Xiph's name.

We need a primary and backup mentor volunteer for any project that is to become an official proposal, but submit something and we'll see who we can round up. :)

note: Google Summer of Code 2007, mentoring organizations to apply between March 5 and March 12, students March 14 - March 24

'''Students''' please use the template at [[Summer of Code Applications]] when applying for a GSoC position.

'''Mentors''' for details of our mentor application and plan, please see [[Summer of Code 2007]].

Students should also check out projects related to the [http://wiki.elphel.com/index.php?title=SoC Elphel Open Source cameras].

=== Optimize Theora encoding/decoding speed, SSE/SSE2 ===
Work on MMX, SSE/SSE2 implementations of the crucial encoding and
decoding elements in [http://svn.xiph.org/trunk/theora/ libtheora] and/or [http://svn.xiph.org/trunk/theora-exp theora-exp].
This could include porting the vp3 mmx and altivec code to the libtheora decoder, and writing sse improvements on the
mmx work that has already been done. The results must still build cleanly on other archs and do
run-time capability detection.

You could start improving this [http://lists.xiph.org/pipermail/theora-dev/2005-August/002838.html MMX loop filter patch for theora-exp] that was never completed nor merged in current theora-exp (see all list thread).

''Mentor: Ralph Giles, Timothy Terriberry, backup: Jan Gerber, Mike Smith''

=== Encode support in theora-exp ===
Implement a rate-distortion optimized encoding mode for [http://svn.xiph.org/trunk/theora-exp/ theora-exp],
including R-D optimzed mode decision and quantization (e.g., constant
lambda). Then, use the above routines to implement a medium-latency ABR
encoding mode (e.g., varying lambda), with a default target buffer size
of approximately 2 seconds.

''Mentor: Timothy "Derf" Terriberry, backup: Mike Smith, Ralph Giles''

=== Development assistant for the "Ghost" audio codec ===
Designing a cutting edge perceptual codec is a very daunting task. Xiph
is in the research stage on a new low-latency, general purpose audio codec,
code-named "Ghost". This is basically a "code assistant" position, where you
will be asked to implement, test, and give feedback on ideas from Christopher
Montgomery, designer of the Ogg Vorbis format. Be prepared to learn a lot about
audio coding, or apply what you already know. While there's less "ownership"
potential in this project proposal, it will be a great opportunity to learn
about compression algorithm design, practice your programming chops, and learn
to work in team.

''Mentor: Christopher "Monty" Montgomery, backup: Jean-Marc Valin''

=== OggMNG implementation ===
Implement the OggMNG decode support in [http://gstreamer.freedesktop.org/dev/ gstreamer] and/or [http://www.illiminable.com/ogg/ illi's dshow filters].
Implement encoding support in based on [http://www.advogato.org/person/company/diary.html?start=18 byzanz] or [http://live.gnome.org/Istanbul Istanbul]. Bonus points for
overlay support. Details on the OggMNG specifications [http://wiki.xiph.org/index.php/OggMNG here]

''Mentors: Mike Smith, Ralph Giles''

=== Theora reference encoder quality optimization ===
The [http://theora.org/download.html libtheora] encoder could make more use of some features present in the spec
but not currently implemented in the encoder. This is a little open ended, but
suggestions are: quant matrix tuning, per-block qi choice, 4:2:2 and 4:4:4 chroma
support.

''Mentor: Ralph Giles, backup: Timothy Terriberry''

=== Subtitle Definition ===
There has been a long-standing need for the introduction of subtitles into Ogg. Several means have been suggested and various implementations exist. However, there has been no standard way that is supported by Xiph at this stage.

The [http://annodex.net/TR/draft-pfeiffer-cmml-03.html CMML] format with its time-aligned means of interleaving text into Ogg bitstreams is a platform on which we would very much like to define a standard means of including subtitles.

In this project, a standard means of interleaving subtitles (as found on DVDs or in srt files) into Ogg will be defined using CMML.

The project requires to make changes to the CMML definition and extend it in several ways. CMML needs to have a valid XML schema or DTD definition associated with it, so that standard XML tools will parse it. The associated documentation should then be updated and software written to put e.g. a srt file into CMML inside Ogg. If there is enough time, it would also be good to implement support for this format in a media player such as vlc or mplayer or xine.

''Mentor: Silvia Pfeiffer, backup: Conrad Parker''

=== Theora support in ekiga ===
Implement support for Theora as a video codec in the [http://www.gnomemeeting.org/ ekiga] chat application.
Overlaps with [http://live.gnome.org/SummerOfCode2006/Ideas GNOME].

''Mentor: Ralph Giles''

=== MXF support in gstreamer ===
Implement an [http://www.digitalpreservation.gov/formats/fdd/fdd000013.shtml MXF] mux/demux for [http://gstreamer.freedesktop.org/dev/ gstreamer], with mappings for [http://xiph.org/vorbis/ Vorbis] and [http://xiph.org/theora Theora].

''Mentors: Christian Schaller, Mike Smith''

=== Cascading Style Sheet support for CMML in GStreamer ===

Implement support for [http://www.w3.org/Style/CSS/ Cascading Style Sheets] to add styling and positioning hints to
[http://annodex.net/TR/draft-pfeiffer-cmml-03.html CMML] text overlays on [http://xiph.org/theora Theora] video. Doing so allows for advanced titling features visually similar to TV-style news headlines, sports scores, and scrolling text. The advantage over conventional "burnt-in" titling is that the stylesheet-driven approach is machine-readable, allowing indexing for search and improved accessibility.

The project involves:
# YUV compositing support in the [http://gstreamer.freedesktop.org/data/doc/gstreamer/0.10.1/gst-plugins-base-plugins/html/gst-plugins-base-plugins-textoverlay.html textoverlay] plugin in [http://gstreamer.freedesktop.org/dev/ gstreamer] in order to complete the low-level support for color and font attributes. Textoverlay already includes partial support for [http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html pango text], but lacks the necessary colorspace conversions. This portion of the project necessarily involves C programming.
# Implementation of a test application to playback video marked up with CSS titling hints. It is recommended that this portion of the project be implemented in a higher-level language for which GStreamer support and CSS parsing libraries exist, such as Python, Ruby or Haskell.

Further work could include support for style sheets in liboggplay / Firefox, or direct support for style sheet retrieval and rendering in GStreamer (via the [http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/gst-plugins-good-plugins-cmmldec.html cmmldec] plugin and/or a new style-sheet-aware textoverlay plugin).

''Mentor: Conrad Parker, backup: Mike Smith, Silvia Pfeiffer''

=== Hardware implementation of Theora decoding ===
Working on a hardware theora decoder, that can be used in embedded
devices, dvd players and video pods. Presumedly GPL verilog source
to run on an FPGA. See http://sourceforge.net/projects/elphel/ for a rough encoder implementation. This was a successful project in 2006.

=== Intel to AT&T x86 assembly translation ===
There is a general need for cross platform projects to be able to compile the same asm accelleration code on both GCC and MSVC. Unfortunately, at least of x86, they have incompatible assembly formats. Currently people either convert one to the other by hand (a maintenance nightmare) or require an external compile/assemble step on one or the other platform.

Start with the (unmaintained?) [http://www.niksula.hut.fi/~mtiihone/intel2gas/ intel2gas] script. Spruce it up to support all of recent MMX, SSE, SSE2, SSE3 instructions. Then implement the reverse translation. Once both are working, write some glue code so it can be easily used as part of a GNU autotools build to derive one set of source from the other at build or package time.

=== Speex and FLAC encoders in Xiph QuickTime Components ===
Implement Speex and FLAC [http://developer.apple.com/documentation/MusicAudio/Reference/CoreAudio/index.html Core Audio] encoders.

[http://xiph.org/quicktime/ XiphQT] has a Vorbis encoder component that could be used as a reference and starting point.

''Mentor: Arek Korbik''

=== New vocoder for Speex ===
Speex currently has a very low bit-rate (2.15 kbps) mode that is implemented as a trivial vocoder. This mode has four "reserved" bits per frame, which means it would be possible to transmit more information. The idea of this project would be to make use of these bits to improve the quality of the 2.15 kbps mode. Changes to both the encoder and the decoder are allowed, provided that they are compatible with older version. This means that the new bit-stream should be decodable by the old decoder with only minor loss in quality. This still leaves plenty of room for improvement. Requires signal processing knowledge.

''Mentor: Jean-Marc Valin''

=== New Speex VAD/VBR code ===
The current Speex VAD/VBR code is a quick hack, put together a long time ago. This project would consist of rewriting it to perform much better under all kinds of conditions. Requires signal processing knowledge.

''Mentor: Jean-Marc Valin''

=== rehuff: a tool to losslessly compress Vorbis files ===
Would be nice to have an updated version of "rehuff", a tool to losslessly compress Vorbis files. There were an experimental version of it (see [http://lists.xiph.org/pipermail/vorbis-dev/2006-August/018522.html rehuff status]), but had some limits:
* it's not free software;
* it has a bug causing the rehuffed file can't correctly seek;
* it works only with stereo files.

Would be nice to have an updated rehuff, without the previous limits, and with a library part that will be included in libvorbisenc, so all encoders could use it (rehuff binary, oggenc, ...).
''Not an official Xiph.org project, only a user proposed idea.''

=== Ogg and Annodex integration into open source web Content Management Systems ===
The goal of this project is to make the use of ogg theora video in existing CMSs as easy as possible.
The project would consist of integrating in browser playback and structured cmml metadata into existing CMSs like mediaWiki, drupal or wordpress.

In browser playback support will be handled by vlc or java cortado plugin and then liboggplay & native browser decoding as that project matures. [http://metavid.ucsc.edu/wiki/index.php/Mv_embed mv_embed] may be a starting point for client plugin detection.
The extension package should also handle thumbnail generation via mplayer or ffmpeg, and ideally support transcodeing via shell calls to ffmpeg2theora. Meta data attributes for the video in the CMS could be exportable as CMML. (a standardized xml format for tagging continues video)

''Mentor: Michael Dale''

== Guidelines for Applying ==

Remember that many people will apply to work on the Summer of Code.

Keep in mind that those of us evaluating your application do not know you, we do not know what kind of
experience you have, we do not know what you have done in the past and we have to pick the best people
suited for a particular task.

Hence, it is very important that you tell us in your email why you should be considered to implement a
particular project. Please use the application template at [[Summer of Code Applications]] as a starting point.

== See Also ==
*[[CodingGuidelines]]
*[[MIT approach to design and implementation]]

List of Theora videos

2006-12-22T10:56:39Z

Mdale: -meta

This is a list of sites where you can download videos encoded with [[Theora]].

;[http://fedoraproject.org/wiki/RenderingProject/aiglx AIGLX]:Demonstration videos for AIGLX, a project that aims to enable GL-accelerated effects on a standard desktop.
;[http://v2v.cc/ V2V]:Video syndication network
;[http://metavid.org Metavid]:Ogg theroa archive of U.S House and Senate Floor Footage.
;[http://post.thing.net/ post.thing.net]:Media site with video torrents.
;[http://punkcast.com/905/ PUNKCAST#905 Richard M Stallman]:Two video clips: ''What's GNU?'' + ''St. IGNUcius''
;[http://gplv3.fsf.org/av GPLv3 Conference, January 16-17 2006]:Speeches by Peter Brown, Eben Moglen and Richard Stallman.
;[http://www.polycrystal.org/lego/movies.html Lego Movies]:Two short movies: ''A New Computer'' and ''Swim''.
;[http://revision3.com/ Revision3]:Tech TV torrents.
;[http://handgranat.org/The_Giver The Giver]:BitTorrent tracker with independent videos and music.
;[http://share.sh.cvut.cz/Theora_demos/ CTU Prague Archive]:[http://creativecommons.org/ Creative Commons] adverts + feature film ''[http://fourthwall.creativecommons.org/honey/ Honey]''.
;[http://www.gnu.org/philosophy/audio/audio.html Speeches about the GNU Project's philosophy]:Featuring Richard Stallman et al.
;[http://www.redhat.com/en_us/USA/rhel/informationcenter/videos/ Red Hat Videos]:Videos about the GNU/Linux vendor's customers and solutions.
;''[http://www.mininova.org/tor/234676 New Waterford Girl]'':Canadian comedy from 1999. Unauthorized copy (not legal in all jurisdictions).
;[http://free-electrons.com/community/videos/conferences/en Free Electrons Conferences]: technical talks given at conferences about free software.
;[http://ulm.ccc.de/ChaosSeminar Ulm CCC Chaosseminar]: (german)
;[http://www.visonair.tv/ Visonair.tv]: Open Access Internet TV channel streaming in ''Ogg Theora''
;[http://dyne.org/~kysucix/index.html?video 11200 undo]: A short movie about computer, religion, sex, glue and so on...
;[http://commons.wikimedia.org/ Wikimedia Commons]: An archive database of 644,951 media files, to which anyone can contribute
;[http://www.archive.org/details/VoyagetothePlanetofPrehistoricWomen Voyage to the Planet of Prehistoric Women] (1967) and [http://www.archive.org/details/TheSnowCreature The Snow Creature] (1954): Full-length public domain movies from the Internet Archive's [http://www.archive.org/details/feature_films collection].
;[http://video.indypgh.org Rustbelt TV]: [http://pittsburgh.indypgh.org Pittsburgh Indymedia's] TV program based on [http://radio.indypgh.org Rustbelt Radio] (audio available as ogg vorbis).

List of Theora videos

2006-12-22T10:55:57Z

Mdale: added metavid

This is a list of sites where you can download videos encoded with [[Theora]].

;[http://fedoraproject.org/wiki/RenderingProject/aiglx AIGLX]:Demonstration videos for AIGLX, a project that aims to enable GL-accelerated effects on a standard desktop.
;[http://v2v.cc/ V2V]:Video syndication network
;[http://metavid.org Metavid]:Ogg theroa archive of U.S House and Senate Floor Footage and meta data.
;[http://post.thing.net/ post.thing.net]:Media site with video torrents.
;[http://punkcast.com/905/ PUNKCAST#905 Richard M Stallman]:Two video clips: ''What's GNU?'' + ''St. IGNUcius''
;[http://gplv3.fsf.org/av GPLv3 Conference, January 16-17 2006]:Speeches by Peter Brown, Eben Moglen and Richard Stallman.
;[http://www.polycrystal.org/lego/movies.html Lego Movies]:Two short movies: ''A New Computer'' and ''Swim''.
;[http://revision3.com/ Revision3]:Tech TV torrents.
;[http://handgranat.org/The_Giver The Giver]:BitTorrent tracker with independent videos and music.
;[http://share.sh.cvut.cz/Theora_demos/ CTU Prague Archive]:[http://creativecommons.org/ Creative Commons] adverts + feature film ''[http://fourthwall.creativecommons.org/honey/ Honey]''.
;[http://www.gnu.org/philosophy/audio/audio.html Speeches about the GNU Project's philosophy]:Featuring Richard Stallman et al.
;[http://www.redhat.com/en_us/USA/rhel/informationcenter/videos/ Red Hat Videos]:Videos about the GNU/Linux vendor's customers and solutions.
;''[http://www.mininova.org/tor/234676 New Waterford Girl]'':Canadian comedy from 1999. Unauthorized copy (not legal in all jurisdictions).
;[http://free-electrons.com/community/videos/conferences/en Free Electrons Conferences]: technical talks given at conferences about free software.
;[http://ulm.ccc.de/ChaosSeminar Ulm CCC Chaosseminar]: (german)
;[http://www.visonair.tv/ Visonair.tv]: Open Access Internet TV channel streaming in ''Ogg Theora''
;[http://dyne.org/~kysucix/index.html?video 11200 undo]: A short movie about computer, religion, sex, glue and so on...
;[http://commons.wikimedia.org/ Wikimedia Commons]: An archive database of 644,951 media files, to which anyone can contribute
;[http://www.archive.org/details/VoyagetothePlanetofPrehistoricWomen Voyage to the Planet of Prehistoric Women] (1967) and [http://www.archive.org/details/TheSnowCreature The Snow Creature] (1954): Full-length public domain movies from the Internet Archive's [http://www.archive.org/details/feature_films collection].
;[http://video.indypgh.org Rustbelt TV]: [http://pittsburgh.indypgh.org Pittsburgh Indymedia's] TV program based on [http://radio.indypgh.org Rustbelt Radio] (audio available as ogg vorbis).