From SoftwarePractice.org

Contents 1 A8 Project Documentation 1.1 Defining The Problem 1.1.1 Introduction 1.1.2 Team Members 1.1.3 Stackholders 1.1.4 Usage Scenarios 1.1.5 Use Case Diagrams 1.1.6 Use Case Description 1.1.7 Use Case 1.2 UML Designs 1.2.1 Class Diagram 1.2.2 Sequence Diagram 1.2.3 GUI Design 1.3 Testing 1.3.1 System Testing 1.3.2 Unit Testing 2 Instructor comments

A8 Project Documentation

Defining The Problem

Introduction

This project is to design and create a Foley sound effects editor. Foley effects are usually smaller compared with sound effects. The Foley effects team will create the small sound like door’s closing or footsteps, sound effects include explosions and car crash noises. The Foley effects team and Sound effects team work very differently as the Foley effects are easier to create as they can use actual doors or shoes with the floor to create the sound and just record it. Sound effects are usually digitally created on the computer or a synthesiser.

A Foley Effects/SFX Editor is a program that is able to record, list and play sequences of sound effects, such as footsteps, or big sound effects like explosions. The program is generally used to run foley sounds and special effects at a selected time in order to synchronise with a video clip. Effects are usually generated by mechanical means, such as springs, flapping cards and other objects or can also be generated by a synthesiser. Foley effects were named after Jack Donovan Foley (1891-1967) who was the first person who put sound effects into movies.

This Foley Effects Editor should be able to record Foley sounds and then is able to add them and list them in a sound library. From the library the default and customised effects will be listed by genres and catergories in the form of treelist. The user then is able to implement these sound effects into individual tracks, at selected times, and then is able to play these tracks while a video is running in order to review such customised sound addons.

Team Members

• William Dali Lin
• Simon Hedge
• Francis Ilagan
• Brinton A. Chand

Stackholders

• Foley Editors
• Video Editor
• Sound Effects Creators
• Film Directors
• Film Editors
• System Administrators

Usage Scenarios

Scenario 1: Recording A Sound

Francis wants to add a sound of someone screaming in pain for his video, but he can't find one he likes in the pre-recorded library, so he decides to record one himself.

Scenario 2: Importing A Sound File To The Library

Will hears the the perfect sound of a sniper rifle on a game. He finds the sound file and wants to add it to his library so he can use it for his video.

Scenario 3: Adding Existing Sound Clips To A Track

Brinton has all his sounds files added into the library. He wants to play multiple gun shots at different times, while having rain and thunder being played in the background.

Scenario 4: Playing A Project

Simon has just finished creating his explosion scene. He made it more realistic, rather than just a huge explosion; he added sounds of debri falling and people screaming and running after the explosion. He wants to see what all this sounds like.

Scenario 5: Removing An Existing Track

Simon feels that his "explosion scene" isn't quite what he's after. He finds that it would sound better if the track that plays the people screaming was removed.

Use Case Diagrams

Use Case Description

Use Case

UML Designs

Class Diagram

We chose to have lots of smaller classes with specialised functionalities, since it made more sense from a logical point of view, and made reading the code (well, should have) a much easier process. The final version of the class diagram had removed some redundant classes, and added a few classes that weren't thought of during design.

Sequence Diagram

Recording a sound file

Importing a sound file

Adding a sound to a track

Playing a project

Removing a track

GUI Design

First Design

Timebar

Control Panel

This was our initial design of what our gui was going to look like

Second Design

After Carefully reading though what was required we decided to get rid of the video part in the GUI and just concentrate on the audio part of the Foley Effects Editor

Final

These images are of the actual program that we created.

Testing

System Testing

Test Case 1

Test Case 2

Test Case 3

Test Case 4

Test Case 5

Unit Testing

Instructor comments

Good stuff, making progress! The classes on the class diagram should match the classes identified with CRC cards. I suggest getting all the info on the CRC cards on to the class diagram and then abandoning the CRC cards (not required for the final deliverable.) JohnR 11:26, 9 September 2006 (UTC)

Your sequence diagrams don't cover all the possible use cases (eg library and other classes not shown). Any progress in last four weeks to upload ?? --Dawsonj 08:53, 8 October 2006 (UTC)