Source

shitsound / readme.html

Full commit
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7056 2011-06-17 10:50:48Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<div class="section" id="shitsound">
<h1>shitsound</h1>
<p>jquery.shitsound.js is a shit sound player for web browsers.</p>
<blockquote>
<ul class="simple">
<li>Listen (demo): <a class="reference external" href="http://rene.f0o.com/~rene/shitsound">http://rene.f0o.com/~rene/shitsound</a></li>
<li>Source code: <a class="reference external" href="https://www.bitbucket.org/illume/shitsound">https://www.bitbucket.org/illume/shitsound</a></li>
</ul>
</blockquote>
<p>Used like this:</p>
<pre class="literal-block">
$.snd.init({}, function () {
        // we are ready to play sounds!  Brilliant.
        $.snd.play('hello');
});
</pre>
<dl class="docutils">
<dt>shitsound only does a few things with sound::</dt>
<dd>play, stop, stopAll</dd>
<dt>jquery.awesound.js might do:</dt>
<dd>changing volume, pitch, playing with a different tempo, playing in stereo, 3d sound, etc.</dd>
</dl>
<p>jquery.shitsound can not do any of this fancy stuff.  It can just play sounds, and stop playing them.</p>
<p>shitsound detects which implementation to use at init time.</p>
<blockquote>
<ul class="simple">
<li>html5, using the html5 audio tag.</li>
<li>embed, for using the embed tag.</li>
<li>soundmanager1, for old flash 7.</li>
<li>soundmanager2, for modern flash (8,9,10+).</li>
<li>empty, pretend implementation that does nothing.</li>
</ul>
</blockquote>
<p>It currently requires jquery, since I use jquery.  However it could quite easily drop the jquery dependency with some work.  Other dependencies are soundmanager 1 and soundmanager 2, as well as (optionally) swfobject.  These are all bundled in ready to use though.</p>
<p>Each implementation is kept separate in the code base, and it is fairly easy to extend with other implementation.  The html5 implementation is separate from the soundmanager1 implementation for example.  I plan on implementing a phonegap implementation in the future.</p>
<p>If you'd like to see another JavaScript audio engine supported, please let me know.</p>
<p>Yes, it does support netscape navigator 3+.  As well as old versions of internet explorer that don't have flash installed, or have old versions of flash installed.</p>
</div>
<div class="section" id="preparing-your-audio">
<h1>preparing your audio</h1>
<p>Because sound support on the web is shit, you need to prepare your audio in various different formats for it to work cross platform.</p>
<p>You need a .wav file, a .mp3 file, and an .ogg file to support all platforms.</p>
<p>It might not be a good idea to include big .wav files for large amounts of audio like songs though.  Because they can be 10 times larger than a lossily compressed mp3 or ogg file.  But if you want full browser support, then .wav files are required.</p>
<p>The ffmpeg is quite a common powerhouse of a multimedia tool.  It is available on OSX through brew, or macports. It can even convert audio for you.</p>
<blockquote>
<ul class="simple">
<li>ffmpeg -i file.wav file.mp3</li>
<li>ffmpeg -i file.wav file.ogg</li>
</ul>
</blockquote>
<div class="section" id="preparing-your-webserver">
<h2>preparing your webserver</h2>
<dl class="docutils">
<dt>If you use nginx you might need to modify your /etc/nginx/mime.types file for oggs::</dt>
<dd>audio/ogg ogg;</dd>
</dl>
<p>Other web servers may also need mime types being added.</p>
</div>
<div class="section" id="future">
<h2>future</h2>
<p>Maybe these things will be done in the future.</p>
<blockquote>
<ul class="simple">
<li>volume control.  This is possible with all backends.</li>
<li>Better browser detection, and blacklisting of bad html5 audio engines.</li>
<li>wider testing and debugging.</li>
</ul>
</blockquote>
</div>
</div>
</div>
</body>
</html>