View on GitHub

clap

A CLI based music player for Windows built as part of CBSE grade 12 project work in C++ w/ Code::Blocks 17.10 IDE

CLAP - Console Lossless Audio Player [DOCUMENTATION]

A CLI based music player for Windows built as part of the CBSE project work for 12th grade in C++ w/ Code::Blocks 17.10 IDE

Introduction

This project was done as part of CBSE project work for 12th grade finals. The standard is C++17. The primary focus of the project was not limited to creating a music player but was also towards utilizing the various features of the programming language and thereby gaining a good exposure with it.

This is a CLI based program which can play and manage WAVE files (others are either proprietary or use complex encoding, so we did not support them since this is a school project).

This is a multi-source project which uses various OOP methodologies. We perform R/W operations on binary files, operator and function overloading, serialization, memory management, exit handling, use DLLs and callbacks, Windows API, limited the use of non ANSI code, optimized UI, optimized performance, multithreading, use of configuration file, better PRNGs and other algorithms, bitmasks, etc.

We also created a data structure similar to std::deque to store the play queue (we didn’t know of std::dequeue until we were halfway through the project, and due to lack of time, we didn’t include it) in which we can insert or remove nodes from any end. It is the Queue class, which was fun designing (It crashed many systems because of simple bugs). The Player class inherits the queue from the Queue class. We found out while coding that OOP is not a simple task and requires a good amount of brainwork and skill.

Features

Technical Information

The WAVE format was developed by Microsoft and IBM in the 1980s. This audio format is capable of storing audio in uncompressed format and compressed formats too. WAVE files are stored in chunks based file format called RIFF (Resource Interchange File Format). The container is (.wav). Linear PCM (Linear Pulse Code Modulation) form is the most straightforward way of storing digital audio, as the notes are directly stored without any form of encoding. Other popular formats of digital audio include FLAC (Free and Lossless Audio Codec), ALAC (Apple Lossless Audio Codec), MP3, AAC etc. WAVE, FLAC and ALAC are lossless audio formats capable of storing CD Quality audio without loss digitally, whereas MP3 (deprecated), AAC etc. are lossy formats. This program demonstrates playback of L-PCM Wave files only.

For example, MP3 at 320Kbps has a loss of 78% of audio compared to uncompressed WAVE files. But WAVE files have a huge size because of storing CDQ Audio in an uncompressed form, which is the very reason why FLAC was developed. Typical CDQ Audio files have a bit rate of 1441Kbps. This is because CDQ Audio has a sample rate of 44.1 KHz, 16 Bits per Second and 2 Channels (left & right) which gives

2 x 16 x 44,100 = 1,411,200 bits per second (bps); or approximately 1411 kbps

Moving to the technicals, WAVE files are stored in RIFF format which has the following structure

Waveform Structure

Here, one can observe that the file is divided into various sections. They are called chunks. The first chunk is the header. All other chunks are subchunks of this chunk, which is called RIFF chunk. The general structure of a subchunk is

struct subChunk
{
    FOURCC ChunkID;
    DWORD ChunkSize;
    LPBYTE Data;
};

Major chunks like RIFF and LIST chunks have the form:

struct Chunk
{
    FOURCC ChunkID;
    DWORD ChunkSize;
    union fccType
    {
        FOURCC ChunkType;
        LPBYTE ChunkData;
    };
};

FOURCC refers to the four-character hex-code of the Chunk ID in ASCII stored in little-endian form

RIFF Chunk

The chunk type of the RIFF chunk in WAVE file is WAVE. The first subchunk is the fmt subchunk, which stores the file details such as SampleRate, ByteRate, Number of Channels, Bits per second etc.

The next chunk stores the audio data in the form of coordinates of the sound wave in hex code for each channel. Then there is an optional chunk called LIST chunk, which is a major chunk (still inside RIFF chunk) which stores audio metadata. People generally say WAVE files cannot be tagged, but there actually is this chunk which allows tagging. Also, recently the ID3v1 tagging format which is used for the MP3 format was made available to other audio formats including WAVE. While LIST/INFO tags can store metadata only in text form and only up to around 30 characters per tag, which are also only a few (20-30) tags, ID3v1 can hold around 100s of tags and album art too. LIST chunks with type INFO are the ones that hold metadata. In the data part of the LIST/INFO chunk, there are many sub chunks holding audio metadata. Some of them are listed below:

Chunk ID Metadata
INAM Title
IART Artist
ITRK Track No.
ICRD Year
ISFT Encoding Software

We have also used a 623-dimensionally equidistributed uniform pseudo-random number generator (PRNG) named Mersenne-Twister (std::mt19937) in honour of scientist Marin Mersenne. In Computer Science, there’s no means of generating a truly random number on its own. They require a seed or a value which varies, on which the computer performs a set of operations to generate a set of random values. The typical C-method is to seed the PRNG with system time. But this method has drawbacks; i.e. when two instances of the software are started simultaneously, the random numbers will be the same. Modern C++ thankfully has many new operators in the <random> header to overcome this, std::random_device copies the state of a random variable of random hardware connected to the system, which will be more variable than system time. It seeds the PRNG with this value. C++ has many PRNGs out of which std::mt19937 (Mersenne twister with state size of 19937 bytes). We can’t use the std::random_device because its entropy is exhausted quickly and has large overheads.

Audio playback is done by the player class with the help of the winmm.dll plugin. This plugin provides access to the Windows Multimedia Library. We have internally used Waveform Functions of Windows API to facilitate audio controls. The data chunk of the WAVE file is loaded to memory using a BYTE (unsigned char) array in Player::Load. Player::Play() function passes the address of the callback function and the loaded data subchunk buffer to WaveOutPrepare() and internally calls WaveOutOpen(). Any message from the DLL invokes the callback function Player::WaveOut_Proc()

Windows API uses certain typedefs to ensure code portability across processor architectures. Some of them used in this program are

Windows Data Type typedef
WORD int with exactly 2 bytes
DWORD int with exactly 4 bytes
BYTE unsigned char
LPBYTE unsigned char *
BOOL bool
DWORD_PTR DWORD *

You can get more information about such typedefs at MSDN

Screenshots

Menu

All Songs

All Songs

Track Info

Track Info

Now Playing

Now Playing

Paused

Paused

About

About

Log File

Log File

Conclusion

The Source code of the program was compiled successfully rectifying all errors. The program will run successfully. The whole program is menu driven and is user-friendly. This program is developed as easy as possible for the sake of the user.

The program isn’t complete in itself and has areas for further improvement. Some possibilities are:

We are sure we will keep better standards in our future programs and we conclude by hoping that our project will be useful for many enthusiasts.