Tanager

Supplementary Specification

Version 3.0 – Elaboration Phase 3

 

Table of Contents

1. Introduction. 2

1.1. Purpose. 2

1.2. Definitions, Acronyms and Abbreviations. 2

1.3. References. 2

1.4. Overview.. 2

2. Functionality. 2

2.1. Digital Rights Management (DRM). 2

3. Usability. 2

3.1. Human Factors. 2

4. Reliability. 2

4.1. Accuracy. 2

4.2. Software Defects. 2

5. Performance. 2

5.1. Response Time. 3

5.2. Capacity. 3

5.3. Resource Utilization. 3

6. Supportability. 3

7. Design Constraints. 3

8. Online User Documentation and Help System Requirements. 3

9. Purchased Components. 3

10. Free Open Source Components. 3

10.1. Java Media Framework. 3

10.2. JID3. 3

11. Interfaces. 3

11.1. User Interfaces. 3

11.2. Hardware Interfaces. 4

11.3. Software Interfaces. 4

11.4. Communications Interfaces. 4

12. Licensing Requirements. 4

13. Legal, Copyright and Other Notices. 4

14. Applicable Standards. 5

15. Revision History. 5

 

Supplementary Specification

1.              Introduction

1.1.         Purpose

This document is the repository of all the requirements of the Tanager project that are not captured in the Use Cases.

1.2.         Definitions, Acronyms and Abbreviations

A complete list of definitions, acronyms, and abbreviations can be found in the Tanager Glossary.

1.3.         References

Java Media Framework. 2005. Sun Microsystems. 09 August, 2005 <http://java.sun.com/products/java-media/jmf/>.

1.4.         Overview

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.

2.              Functionality

2.1.         Digital Rights Management (DRM)

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

3.              Usability

3.1.         Human Factors

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.

4.              Reliability

4.1.         Accuracy

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.

4.2.         Software Defects

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.

5.              Performance

5.1.         Response Time

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.

5.2.         Capacity

The capacity of the Tanager system is limited by the resources available on the user’s computer system.

5.3.         Resource Utilization

The Tanager system must not over-utilize the user’s computer system resources and cause slow-downs with other executing programs.

6.              Supportability

7.              Design Constraints

Tanager will be implemented use Java technologies, so any libraries or add-ins that will be utilized must be compatible with Java.

8.              Online User Documentation and Help System Requirements

Since Tanager is a very simple music player, only very simple online documentation will be provided.

9.              Purchased Components

None.

10.          Free Open Source Components

10.1.     Java Media Framework

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.

10.2.     JID3

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.

11.          Interfaces

11.1.     User Interfaces

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.

11.2.     Hardware Interfaces

None.

11.3.     Software Interfaces

The software interface for Sun Microsystems’ Java Media Framework can be found here.

11.4.     Communications Interfaces

None.

12.          Licensing Requirements

See Section 2.1 Digital Rights Management (DRM).

13.          Legal, Copyright and Other Notices

The Tanager project is licensed under the BSD license as given below.

Copyright (c) 2005-2007, Iowa State University
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 Iowa State University nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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.

14.          Applicable Standards

 

15.           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

3.0 – Elaboration Phase 3

Revised with comments from review by Dr. Leavens (added section 4.2).

Bob Lavey