Tanager
Supplementary Specification
Version 3.0 – Elaboration Phase 3
Revision History
|
Date |
Version |
Description |
Author |
|
14 Nov, 2005 |
1.0 - Inception Phase |
Initial revision. This specification will be refined and expanded during the life of the project. |
Bob Lavey |
|
29 Nov, 2005 |
1.1 – Inception Phase |
Revised with comments from review by Dr. Leavens. |
Bob Lavey |
|
27 Oct, 2006 |
2.0 – Elaboration Phase 1 |
Revised with comments from review by Dr. Leavens. |
Bob Lavey |
|
18 Jan, 2007 |
Revised with comments from review by Dr. Leavens (added section 4.2). |
Bob Lavey |
Table of Contents
1.2. Definitions,
Acronyms and Abbreviations
2.1. Digital
Rights Management (DRM)
8. Online
User Documentation and Help System Requirements
10. Free
Open Source Components
11.4. Communications
Interfaces
13. Legal,
Copyright and Other Notices
Supplementary Specification
This document is the repository of all the requirements of the Tanager project that are not captured in the Use Cases.
A complete list of definitions, acronyms, and abbreviations can be found in the Tanager Glossary.
Java
Media Framework. 2005. Sun Microsystems. 09 August, 2005 <http://java.sun.com/products/java-media/jmf/>.
This document will describe the non-functional requirements of the Tanager project, such as usability, reliability, supportability, and licensing. This document will also describe functionality that is not expressible using use cases.
Any music file that has a DRM flag set will have its license validated before the files can be played. Only files that are successfully validated will be played by the Tanager system
Since Tanager will be running on the user’s computer and sharing desktop space with other programs, it should take up as little space as possible while still allowing the user to accurately press buttons and read the display.
It is of paramount importance that the user’s music files are played accurately. There must be no noticeable skipping or stuttering while songs are playing.
In
the software-based version of Tanager, the user expects the system to run
without errors and without crashing the computer it’s running on. There may be minor defects in the code but no
major defects that cause crashes or hangs.
The Tanager system must respond to user button-presses in less than one second. Button presses made while the user is traversing the menu system must be processed in less than half a second.
The capacity of the Tanager system is limited by the resources available on the user’s computer system.
The Tanager system must not over-utilize the user’s computer system resources and cause slow-downs with other executing programs.
Tanager will be implemented use Java technologies, so any libraries or add-ins that will be utilized must be compatible with Java.
Since Tanager is a very simple music player, only very simple online documentation will be provided.
None.
Sun Microsystems’ Java Media Framework will be used as the underlying audio media player for the Tanager system. The Java Media Framework is licensed under the JMF 2.1.1 Binary Code License: http://java.sun.com/products/java-media/jmf/2.1.1/license.html.
Code to read the ID3 tags used in MP3 files is licensed from jid3.blinkenlights.org under the Lesser Gnu Public License: http://www.gnu.org/copyleft/lesser.html.
The user interface will consist of:
· an on/off button
· an “up” button to be used for menu traversal
· a “down” button to be used for menu traversal
· an “up volume” button
· a “down volume” button
· a “forward” button for skipping to the next song
· a “back” button for repeating the current song or skipping to the previous song
· a “menu” button for accessing the menus
· a “select” button for choosing menu items
There may not need to be separate buttons for each of these functions, though. It is likely that we will have context-sensitive “up”, “down”, “right”, and “left” buttons to handle song skipping/repeating, volume control, and menu traversal. Similarly, there may be a single button that handles the “menu” and “select” functionality.
None.
The software interface for Sun Microsystems’ Java Media Framework can be found here.
None.
See Section 2.1 Digital Rights Management (DRM).
The Tanager project is licensed under the BSD license as given below.
Copyright (c) 2005-2006,
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
· Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
· Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
·
Neither the name of
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.