Upload a file

From smultron.org

Jump to: navigation, search

Contents

Goal

Upload an audio file.

Description

Audio files have to be uploaded to the server in order to be available for broadcast. Files have to be tagged, in order to be found.

Actors

DJ, Editor.

Constraints

  • The file has to be an audio file in a format that is playable by the system.
  • There could be a maximum size imposed.
  • The file's license has to meet station policy.

Main success scenario

  1. A DJ chooses a file from disk and starts an upload request.
  2. The file's format is checked.
  3. The file's size is checked.
  4. Metadata embedded in the file is read.
  5. The DJ is asked to input some information on the file, or to correct the information obtained by reading the file's metadata.
    1. Name of the track
    2. Release
    3. Artist
    4. Track number
    5. Notes
    6. Choose a license.
    7. Input external URL's: MusicBrainz, Youtube, Soundcloud, Wikipedia, Other
    8. Add Tags
  6. File information is displayed:
    1. filesize
    2. fileformat
    3. dataformat
    4. channelmode
    5. sample_rate
    6. fileformat
    7. bitrate
    8. bitrate mode
    9. compression ratio
    10. encoding
    11. encoder options
    12. length

Post-conditions for main success scenario

  • The file is stored on the server.
  • The data for the file is stored in the database.
  • An enclosing record release entry was found or has been created.
  • An associated artist has been found or has been created.

Other scenarios

File format is not accepted
Only file formats known to the system as playable audio files can be uploaded. If a DJ tries to upload another kind of file, a notification has to be issued.
File is too big or too small.
The server will have a size limit for posts containing binary data. If the file exceeds this size, the request will not be processed. There should be an additional, smaller, maximum file size for the system. This allows for the maximum file size to be edited without compromising the server's security. The file should be checked for a minimum file size as well, to prevent empty file uploads.
Metadata has wrong encoding
Some file formats, such as ogg, specify that metadata should be encoded as utf-8. Some other formats do not specify an encoding. The server should definitely keep to utf-8, to avoid common problems of internationalisation. For this, the metedata should be converted to utf-8.
Required fields
Some fields should always be required, such as track name and license. Other fields such as release and label, are optional.
Special expressions
Some expressions should be reserved for their special meaning: 'various artists', 'unknown artist', 'unknown album' etc. If care is not taken to filter these out, it will certainly cause trouble, e.g. when a certain artists is assigned all 'unknown albums' etc.

Related use cases

  • Retrieve metadata from external service

Related documents

Personal tools