[disorder] / CHANGES.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<title>DisOrder Change History</title>
<link rel=StyleSheet type="text/css" href="docs.css">
</head>

<body>
<h1>DisOrder Change History</h1>

<p>This file documents recent user-visible changes to <a
 href="http://www.greenend.org.uk/rjk/disorder/">DisOrder</a>.</p>

<p><b>IMPORTANT</b>: you should read <a
href="README.upgrades.html">README.upgrades</a> before upgrading.</p>

<h2>Changes up to version 5.1</h2>

<div class=section>

  <h3>Removable Device Support</h3>

  <div class=section>

    <p>The server will now automatically initiate a rescan when a filesystem is
    mounted or unmounted.  (Use the <tt>mount_rescan</tt> option if you want to
    suppress this behavior.)</p>

    <p>The server takes care not to hold audio files open unnecessarily, so
    that devices can be unmounted even if tracks from them are currently being
    buffered.</p>

  </div>

  <h3>Disobedience</h3>

  <div class=section>

    <p>You can now edit the <tt>required-tags</tt> and <tt>prohibited-tags</tt>
    global preferences in Disobedience
    (<a href="http://code.google.com/p/disorder/issues/detail?id=29">issue
    #29</a>).</p>

    <p>The &ldquo;Manage users&rdquo; option is now more reliably greyed out if
    it will not work.  This depends on a server change too, so it may still be
    wrong if a new Disobedience is used against an old server.</p>

    <p>A <tt>.desktop</tt> file is now shipped, making Disobedience visible as
    an application in freedesktop.org-compliant systems.</p>

  </div>

  <h3>Backups</h3>

  <div class=section>

    <p>The Debian package now includes a cronjob that backs up the database
    daily.  See <tt>/etc/cron.d/disorder</tt>.  You can put settings
    in <tt>/etc/default/disorder</tt> to turn this off or to control how long
    the backups are kept for.</p>

    <p>The <tt>disorder-dump -r</tt> option was broken.</p>

    <p><tt>disorder-dump</tt> now gets permissions right automatically (<a
    href="http://code.google.com/p/disorder/issues/detail?id=56">issue
    #56</a>).</p>

  </div>

  <h3>GStreamer support</h3>

  <div class=section>

    <p>If it's detected at <tt>configure</tt> time, a new decoder
    program <tt>disorder-gstdecode</tt> is built.  It uses the GStreamer
    library for audio decoding and sample-rate conversion, among other
    features.

    <p>The decoder has a number of options for controlling the sample-rate and
    audio format conversion, allowing various tradeoffs between quality and
    processor time.  (High-quality conversion can consume more processor time
    than decoding, so this is potentially useful on very a small device such as
    a Raspberry Pi.</p>

    <p>The GStreamer decoder can also use ReplayGain information stored in
    audio files' metadata to adjust playback volume, so that tracks with very
    wide dynamic range don't sound really quiet in comparison.  This
    information can be added using tools such as <tt>mp3gain</tt>,
    <tt>vorbisgain</tt>, or <tt>metaflac</tt>.  This is turned on by default if
    you use the decoder; you can choose between per-album or per-track
    settings, or turn it off entirely, using command-line options.</p> 

    <p>The GStreamer decoder is not used by default, but it can be enabled
    easily enough by dropping something like the following into the server
    configuration file:
      <pre>
        player
        player *.flac execraw /usr/sbin/disorder-gstdecode -ralbum -f-8.0
        player *.mp2 execraw /usr/sbin/disorder-gstdecode -ralbum -f-8.0
        player *.mp3 execraw /usr/sbin/disorder-gstdecode -ralbum -f-8.0
        player *.ogg execraw /usr/sbin/disorder-gstdecode -ralbum -f-8.0
        player *.wav execraw /usr/sbin/disorder-gstdecode -ralbum -f-8.0
      </pre>
    </p>

  <h3>General</h3>

  <div class=section>

    <p>Unicode support has been upgraded to <a
    href="http://www.unicode.org/versions/Unicode6.0.0/">Unicode
    6.0.0</a>.</p>

    <p>Client programs no longer depend on libdb.</p>
    
    <p>The following have been removed:</p>

    <ul>

      <li>The <tt>allow</tt>, <tt>gap</tt>, <tt>lock</tt>, <tt>prefsync</tt>, 
      <tt>restrict</tt>, <tt>trust</tt> configuration commands.  If they still
      appear in your configuration file then the server will not start.</li>

      <li>The <tt>columns</tt> web interface option.  It will generate an
      message in your error log but otherwise be ignored.</li>

      <li>The <tt>--wait-for-device</tt> player option.  If it still appears in
      any player commands, they will not work.</li>

      <li>Support for automatically importing pre-3.0 users.</li>

    </ul>

    <p>Various minor bug fixes.</p>

  </div>

</div>

<h2>Changes up to version 5.0.3</h2>

<div class=section>

<p><b>Security</b>: Local connections can no longer create and delete users
unless they are properly authorized.</p>

</div>

<h2>Changes up to version 5.0.2</h2>

<div class=section>

<p>The login form now indicates that a cookie will be set.</p>

</div>

<h2>Changes up to version 5.0.1</h2>

<div class=section>

<h3>Disobedience</h3>

<div class=section>

<p>The sense of the Control &#x2192; Playing menu item was fixed.</p>

</div>

</div>

<h2>Changes up to version 5.0</h2>

  <div class=section>
  
    <h3>Server</h3>
 
    <div class=section>

      <p>The <tt>device</tt> configuration option now works under OS X.
      Devices may
      be specified either by UID or name.  Fixes <a
       href="http://code.google.com/p/disorder/issues/detail?id=27">Issue
      27</a>.</p>

      <p>Gapless play should be more reliable, and playback latency over RTP
      should be a bit lower.  Note though that all the sound output code has
      been reorganized and in some cases completely rewritten, so it's possible
      that bugs may have been (re-)introduced.  Decoding of scratches is also
      initiated ahead of time, giving more reliable playback.</p>
      
      <p>The <tt>command</tt> backend now (optionally) sends silence instead
      of suspending writes when a pause occurs or no track is playing.</p>

      <p>If <a href="http://www.mega-nerd.com/SRC/">libsamplerate</a> is
      available at build time then that will be used instead of invoking
      <a href="http://sox.sourceforge.net/">SoX</a>.  SoX support will be
      removed in a future version.</p>

      <p>The libao plugin has been removed, because the plugin API is not
      usable in libao 1.0.0.</p>

      <p>Playlists are now supported.  These allow a collection of tracks to be
      prepared offline and played as a unit.</p>

    </div>
      
    <h3>Disobedience</h3>

    <div class=section>

      <p>Multiple tracks can now be dragged in the queue in a single operation.
      Furthermore, it is now possible to drag tracks from the
      &ldquo;Recent&rdquo;, &ldquo;Added&rdquo; and &ldquo;Choose&rdquo; tabs
      to the queue.</p>

      <p>Disobedience now supports playlist editing and has a compact mode,
      available from the <b>Control</b> menu.</p>

      <p>Disobedience has a <a href="disobedience/manual/index.html">new
      manual</a>.</p>

    </div>

    <h3>Web Interface</h3>
 
    <div class=section>

      <p>Confirmation URLs should be cleaner (and in particular not end
      with punctuation).  (Please see <a
      href="README.upgrades.html">README.upgrades</a> for more about this.)</p>

    </div>
      
    <h3>RTP Player</h3>
  
    <div class=section>

      <p>There is a new <tt>--command</tt> option which allows the RTP player
      to send audio data to a user-chosen command instead of an audio API. See
      the man page for details.</p>
      
      <p>The <tt>--device</tt> option to <tt>disorder-playrtp</tt> now works
      under OS X (as above).</p>
        
    </div>
      
    <h3>General</h3>

    <div class=section>

      <p>IPv6 should now work.  Network address specifications
      (<tt>listen</tt>, <tt>connect</tt> etc) can now be prefixed with
      <tt>-4</tt> or <tt>-6</tt> to force use
      of IPv4 or IPv6, though normally this should not be needed.</p>

      <p>Unicode support has been upgraded to <a
      href="http://www.unicode.org/versions/Unicode5.1.0/">Unicode
      5.1.0</a>.</p>

      <p>Various elements of the source code have been
      rationalized.</p>
      
    </div>
    
    <h3>Bugs fixed</h3>
  
    <div class=section>

      <table class=bugs>
        <tr>
          <th>ID</th>
          <th>Description</th>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=22">#22</a></td>
          <td>Background decoders interact badly with server reload</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=27">#27</a></td>
          <td>Mac DisOrder uses wrong sound device</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=30">#30</a></td>
          <td>mini disobedience interface</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=32">#32</a></td>
          <td>Excessively verbose log chatter on shutdown</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=33">#33</a></td>
          <td>(Some) plugins need -lm.</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=39">#39</a></td>
          <td>Double bind() non-multicast AF_INET</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=40">#40</a></td>
          <td>Missing stub function</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=41">#41</a></td>
          <td>Missing includes for timeval</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=42">#42</a></td>
          <td>syntax error in empeg_host section</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=43">#43</a></td>
          <td>decoder segfault with FLAC 1.2.1</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=44">#44</a></td>
          <td>gcc 4.3.2-1ubuntu12 SUYB patch</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=45">#45</a></td>
          <td>disobedience doesn't configure its back end</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=46">#46</a></td>
          <td>Sort search results in web interface</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=48">#48</a></td>
          <td>build-time dependency on <tt>oggdec</tt> removed</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=49">#49</a></td>
          <td>Disobedience's 'When' column gets out of date</td>
        </tr>

        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=51">#51</a></td>
          <td>Improved speaker process robustness</td>
        </tr>

        <tr>
          <td>(none)</td>
	  <td>&ldquo;found track in no collection&rdquo; messages for scratches
	  are now suppressed</td>
        </tr>

        <tr>
          <td>(none)</td>
          <td>Disobedience would sometimes fail to notice when a track
          started, leading to its display getting out of date.</td>
        </tr>

      </table>
    </div>
  </div>

<h2>Changes up to version 4.3</h2>

  <div class=section>

    <h3>Disobedience</h3>

      <div class=section>

        <p>A bug was fixed in the calculation of how much of the track had
        played.  This would lead to the counter showing incorrect values in
        various situations.</p>

        <p>Disobedience's icons have been changed to larger, more colorful
        ones.  The SVG source is included if you want to fiddle with them.</p>

        <p>&ldquo;Select all&rdquo; is now no longer available in the choose
        tab.  Instead there is a new &ldquo;Select children&rdquo; option which
        selects the file children of a single subdirectory.</p>

      </div>

    <h3>Server</h3>

      <div class=section>

        <p>The selection bias for newly added tracks was reduced by half.  You
        can put it back to the old very neophilic value with
        &ldquo;<tt>new_bias 900000</tt>&rdquo; in the config file.</p>

        <p>It is now possible to &lsquo;adopt&rsquo; randomly picked tracks.
        Disobedience and the command-line client support this but the web
        interface does not.</p>

        <p>The default track name parsing was modified to handle filenames
        generated by iTunes.</p>
        
      </div>

    <h3>Miscellaneous</h3>

      <div class=section>

        <p><tt>disorderfm</tt> now preserves directory permissions.</p>

        <p>DisOrder is now licensed under <a
         href="http://www.gnu.org/licenses/gpl-3.0.html">GPL v3</a>.  The main
        goal is to prohibit <a
         href="http://en.wikipedia.org/wiki/Tivoization">Tivoization</a>.</p>

        <p>The build system will now automatically cope with Fink's broken GTK+
        packages.  There are a number of improvements to the Debian
        packaging.</p>

        <p>DisOrder now builds on 64-bit Linux systems.</p>

        <p>There are various minor fixes.</p>

      </div>

  <h3>Bugs fixed</h3>
  
    <div class=section>

      <table class=bugs>
        <tr>
          <th>ID</th>
          <th>Description</th>
        </tr>
        
        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=24">#24</a></td>
          <td>Fails to build on ubuntu 8.10</td>
        </tr>
        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=26">#26</a></td>
          <td>Disobedience shows wrong track elapsed time after a pause</td>
        </tr>
      </table>
      
    </div>
  </div>

<h2>Changes up to version 4.2</h2>

<div class=section>

  <h3>Disobedience</h3>
  
    <div class=section>

      <p>The login window now has a 'remote' switch.  If this is turned off
      then Disobedience will connect to a local server.  Formerly it would
      always use TCP/IP.</p>

      <p>The Delete and backspace keys will now remove tracks from the queue.
      Escape will now dismiss the properties, users or login windows and return
      now works in the login and properties windows.</p>
      
    </div>

  <h3>Documentation</h3>
  
    <div class=section>

      <p>Track and global preferences are now described in a new
      <b>disorder_preferences</b>(5) man page.</p>
      
    </div>

  <h3>Bugs fixed</h3>
  
    <div class=section>

      <table class=bugs>
        <tr>
          <th>ID</th>
          <th>Description</th>
        </tr>
        
        <tr>
          <td><a href="http://code.google.com/p/disorder/issues/detail?id=21">#21</a></td>
          <td>CGI should use PATH_INFO more sensibly</td>
        </tr>
      </table>
      
    </div>
</div>


<h2>Changes up to version 4.1.1</h2>

<div class=section>

  <p>Disobedience's &ldquo;Login&rdquo; window now works when you are logged
  in.</p>
  
</div>

<h2>Changes up to version 4.1</h2>

<div class=section>

  <h3>Disobedience</h3>
  
    <div class=section>
  
      <p>Disobedience has been largely rewritten:</p>

      <ul>
        
        <li>All the tabs now use native GTK+ list/tree widgets, resulting in
        greater speed in some cases and more consistency with other GTK+
        applications.</li>

        <li>You can now use type-ahead find in the choose tab.  The initiation
        of a search is delayed slightly to avoid lots of updates when you're
        half way through entering search terms.</li>

        <li>The choose tab now shows track lengths.</li>
    
        <li>Many buttons are now more reliably made insensitive when they can't
        be used.</li>

        <li>You can now play tracks off the recent tab.</li>
        
      </ul>
      
      <p>Disobedience attempts to cope with servers from older versions, up to
      a point, but this is not well tested and it's best to keep the server
      fully up to date.</p>

    </div>
     
  <h3>Server</h3>
  
    <div class=section>

      <p>When a track shares a directory with its alias, the real track name is
      now returned instead of the alias (the opposite way round to the previous
      behaviour).</p>
      
    </div>
</div>

<h2>Changes up to version 4.0.2</h2>

<div class=section>

  <p>Corrected web browser linked from Disobedience.</p>
  
</div>

<h2>Changes up to version 4.0.1</h2>

<div class=section>

  <p>Libtool and Automake now install the CGI correctly.  As part of this,
  <tt>cgidir</tt> has been renamed to <tt>cgiexecdir</tt>.  The configure
  script will report an error if you try to use the old name.</p>
  
</div>

<h2>Changes up to version 4.0</h2>

<div class=section>

  <h3>Server</h3>

<div class=section>
  
  <p>The <tt>gap</tt> directive will no longer work.  It could be
  restored if there is real demand.</p>
  
  <h4>Event Scheduling</h4>

<div class=section>

  <p>It is now possible to schedule events to occur in the future.
  Currently the supported actions are playing a specific track, and
  changing a global preference (thus allowing e.g. random play to be
  turned on or off).  See the <tt>schedule-*</tt>
  commands described in disorder(1).</p>

</div>

<h4>Random Track Choice</h4>

<div class=section>

  <p>This has been completely rewritten to support new features:</p>

  <ul>

    <li>tracks in the recently-played list or in the queue are no longer
    eligible for random choice.</li>

    <li>there is a new <tt>weight</tt> track preference allowing for
    non-uniform track selection.  See disorder(1) for details.</li>

    <li>there is a new configuration item <tt>replay_min</tt> defining
    the minimum time before a played track can be picked at random.
    The default is 8 hours (which matches the earlier behaviour).</li>

    <li>recently added tracks are biased up; see <tt>new_bias</tt> and
    <tt>new_bias_age</tt> in disorder_config(5).</li>

  </ul>

</div>

<h4>Web Interface</h4>

<div class=section>

  <p>This has been largely rewritten.  The most immediate benefits are:</p>

  <ul>
    
    <li>the search page is integrated into the choose page, and
    includes links to parent directories.</li>
    
    <li>if you try to do something you have insufficient rights for,
    instead of getting an error page or nothing happening, you are
    redirected to the login page.</li>

  </ul>

  <p>Customizers should find their lives easier: the syntax is less onerous, it
  is possible to define macros to avoid repetition, and the documentation is
  less monolithic (see disorder.cgi(8) as a starting point).</p>

  <p>Mail is now sent via the system sendmail program, though it remains
  possible to use TCP to connect to an SMTP server.  See <tt>sendmail</tt> and
  <tt>smtp_server</tt> in disorder_config(5).</p>

  <p>The web interface is now installed automatically.  If you don't want it,
  use <tt>./configure --without-cgi</tt>.  If you want it in a non-default
  location, or no location for it is detected, set <tt>cgidir</tt>
  and <tt>httpdir</tt> on the <tt>./configure</tt> command line.</p>
  
</div>

</div>

<h3>Disobedience</h3>

<div class=section>

  <p>There is now a new user management window.  From here you can add and
  remove users or modify their settings.</p>

  <p>Relatedly, the server will only allow remote user management if you set
  <tt>remote_userman</tt> to <tt>yes</tt>.</p>

</div>

<h3>Miscellaneous</h3>

<div class=section>

  <p><tt>scripts/setup</tt> now honors command line options, and can
  set up network play as well as the local default sound device.</p>

</div>

<h3>Bugs Fixed</h3>

<div class=section>

  <table class=bugs>
    <tr>
      <th>ID</th>
      <th>Description</th>
    </tr>

    <tr>
      <td><a href="http://code.google.com/p/disorder/issues/detail?id=2">#2</a></td>
      <td>Search results should link to directories</td>
    </tr>

    <tr>
      <td><a href="http://code.google.com/p/disorder/issues/detail?id=6">#6</a></td>
      <td>Schedule tracks for a particular time</td>
    </tr>

    <tr>
      <td><a href="http://code.google.com/p/disorder/issues/detail?id=10">#10</a></td>
      <td>Non-uniform track selection</td>
    </tr>

    <tr>
      <td><a href="http://code.google.com/p/disorder/issues/detail?id=11">#11</a></td>
      <td>Bias random selection to newly added tracks</td>
    </tr>

    <tr>
      <td><a href="http://code.google.com/p/disorder/issues/detail?id=13">#13</a></td>
      <td>Default encoding for debian setup scripts</td>
    </tr>

    <tr>
      <td><a href="http://code.google.com/p/disorder/issues/detail?id=16">#16</a></td>
      <td>Cookie expiry causes user to be silently logged out and not
      subsequently redirected to login page</td>
    </tr>
    
    <tr>
      <td><a href="http://code.google.com/p/disorder/issues/detail?id=20">#20</a></td>
      <td>Broken aliasing rules</td>
    </tr>
    
  </table>

</div>

</div>

<h2>Changes up to version 3.0.2</h2>

<div class=section>

  <p>Builds <tt>--without-server</tt> should work again.</p>

  <p>The web interface is a bit more liberal in the cookie value
  syntax it will accept.</p>

  <p>Clients fail more gracefully if no password is available.</p>

</div>

<h2>Changes up to version 3.0.1</h2>

<div class=section>
  
  <p>Debian upgrades from 2.0.x should now work better.</p>
  
</div>

<h2>Changes up to version 3.0</h2>

<div class=section>
  
  <p><b>Important</b>!  See <a
  href="README.upgrades.html">README.upgrades</a> when upgrading.</p>
  
  <h3>Platforms And Installation</h3>
  
<div class=section>
  
  <p>Mac OS X and FreeBSD are somewhat supported.  There is now a bash
  script in <tt>scripts/setup</tt> which will automate the setup after
  <tt>make install</tt>.</p>
  
</div>

<h3>Server</h3>

<div class=section>
  
  <p>Users are now stored in the database rather than a configuration
  file.</p>
  
  <p>The server now has a built-in list of stopwords and players, so
  only additions to these need be mentioned in the configuration file.</p>
  
  <p>The default inter-track gap is now 0s.</p>
  
  <p>How sound is played is now controlled via the new <tt>api</tt>
  configuration command.  This also controls how the volume is set,
  which now works with ALSA as well as OSS.</p>
  
  <p>A bug in the MP3 decoder was fixed (also in 2.0.4).</p>
  
</div>

<h3>Web Interface</h3>

<div class=section>
  
  <p>The web interface now uses cookies to remember user identity, and
  allows online registration of new users.  Also it is no longer
  necessary to manually specify the URL of the web interface (but you
  can override it if you don't like the value it figures out).</p>
  
  <p>It is possible to allow users to register via the web interface.</p>
  
  <p>The web interface's browser support has been improved.  It has
  been tested with Firefox 2, Safari 3, Konqueror 3, Internet Explorer
  7 and Opera 9.</p>
  
</div>

<h3>Disobedience</h3>

<div class=section>

  <p>A bug which would cause a crash if you attempt to rearrange the
  queue while no track was playing has been fixed.  There is a new
  'deselect all tracks' option, mirroring 'select all tracks.</p>
  
</div>

</div>

<!--
Local Variables:
fill-column:79
indent-tabs-mode:nil
End:
-->