upm/src/wt5001/wt5001.h

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#pragma once

#include <string>
#include <iostream>

#include <stdint.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <fcntl.h>
#include <errno.h>
#include <termios.h>
#include <sys/time.h>
#include <sys/select.h>
#include <sys/types.h>
#include <sys/stat.h>

#include <mraa/uart.h>

const int WT5001_DEFAULT_UART = 0;
const int WT5001_MAX_VOLUME = 31;

// protocol start and end codes
const uint8_t WT5001_START = 0x7e;
const uint8_t WT5001_END   = 0x7e;

namespace upm {

  /**
   * @brief C++ API for the WT5001 Serial MP3 module
   *
   * UPM support for the WT5001 Serial MP3 Module.  This was tested
   * specifically with the Grove Serial MP3 module.
   *
   * @ingroup grove uart
   * @snippet wt5001.cxx Interesting
   */
  class WT5001 {
  public:

    // WT5001 opcodes
    typedef enum { NONE             = 0x00,
                   PLAY_SD          = 0xa0,
                   PLAY_SPI         = 0xa1,
                   PLAY_UDISK       = 0xa2,
                   PAUSE            = 0xa3,
                   STOP             = 0xa4,
                   NEXT             = 0xa5,
                   PREVIOUS         = 0xa6,
                   SET_VOLUME       = 0xa7,
                   QUEUE            = 0xa8,
                   PLAY_MODE        = 0xa9,
                   COPY_SD2FLASH    = 0xaa, // not implemented
                   COPY_UDISK2FLASH = 0xab, // not implemented
                   INSERT_SONG      = 0xac,
                   SET_DATE         = 0xb1,
                   SET_TIME         = 0xb2,
                   SET_ALARM        = 0xb3,
                   SET_ALARM_DUR    = 0xb4, // not implemented
                   CLEAR_ALARM      = 0xb5,
                   CLEAR_ALARM_DUR  = 0xb6, // not implemented
                   READ_VOLUME      = 0xc1,
                   READ_PLAY_STATE  = 0xc2,
                   READ_SPI_NUMF    = 0xc3,
                   READ_SD_NUMF     = 0xc4,
                   READ_UDISK_NUMF  = 0xc5,
                   READ_CUR_FNAME   = 0xc6,
                   READ_CF_CHAR     = 0xc7, // not implemented
                   READ_DATE        = 0xd1,
                   READ_TIME        = 0xd2
    } WT5001_OPCODE_T;
    
    // play modes
    typedef enum { NORMAL           = 0x00,
                   SINGLE_REPEAT    = 0x01,
                   ALL_REPEAT       = 0x02,
                   RANDOM           = 0x03
    } WT5001_PLAYMODE_T;
    
    // music source
    typedef enum { SD,
                   SPI,
                   UDISK
    } WT5001_PLAYSOURCE_T;
    
    /**
     * WT5001 Serial MP3 module constructor
     *
     * @param uart default uart to use (0 or 1)
     * @param tty tty device to use
     */
    WT5001(int uart, const char *tty);

    /**
     * WT5001 Serial MP3 module Destructor
     */
    ~WT5001();

    /**
     * Check to see if there is data available for reading
     *
     * @param millis number of milliseconds to wait, 0 means no wait.
     * @return true if there is data available to be read
     */
    bool dataAvailable(unsigned int millis);

    /**
     * read any available data into a user-supplied buffer.  Note, the
     * call will block until data is available to be read.  Use
     * dataAvailable() to determine whether there is data available
     * beforehand, to avoid blocking.
     *
     * @param buffer the buffer to hold the data read
     * @param len the length of the buffer
     * @return the number of bytes read
     */
    int readData(char *buffer, size_t len);

    /**
     * write the data in buffer to the device
     *
     * @param buffer the buffer to hold the data read
     * @param len the length of the buffer
     * @return the number of bytes written
     */
    int writeData(char *buffer, size_t len);

    /**
     * setup the proper tty i/o modes and the baudrate.  The default
     * baud rate is 9600 (B9600).
     *
     * @param baud the desired baud rate.  
     * @return true if successful
     */
    bool setupTty(speed_t baud=B9600);

    /**
     * Get a command response and return it's validity
     *
     * @param index opcode to verify
     * @return true if successful
     */
    bool checkResponse(WT5001_OPCODE_T opcode);
    
    /**
     * play a file, from a source
     *
     * @param psrc the play source (SD, UDISK, SPI)
     * @param index file number to play
     * @return true if successful
     */
    bool play(WT5001_PLAYSOURCE_T psrc, uint16_t index);

    /**
     * stop playing
     *
     * @return true if successful
     */
    bool stop();

    /**
     * pause playback, or resume playback if already paused
     *
     * @return true if successful
     */
    bool pause();

    /**
     * go to next track
     *
     * @return true if successful
     */
    bool next();

    /**
     * go to previous track
     *
     * @return true if successful
     */
    bool previous();

    /**
     * set the volume. Range is between 0-31.  0 means mute.
     *
     * @return true if successful
     */
    bool setVolume(uint8_t vol);

    /**
     * queue a track to play next, when current song is finished
     *
     * @param index file number to queue
     * @return true if successful
     */
    bool queue(uint16_t index);

    /**
     * set the playback mode
     *
     * @param pm play mode to enable
     * @return true if successful
     */
    bool setPlayMode(WT5001_PLAYMODE_T pm);

    /**
     * insert a track to play immediately, interrupting the current
     * track.  When the inserted track is finished playing, the
     * interrupted track will resume where it was interrupted.
     *
     * @param index file number to insert
     * @return true if successful
     */
    bool insert(uint16_t index);

    /**
     * set the date of the internal clock
     *
     * @param year 4 digit year
     * @param month the month
     * @param day the day
     * @return true if successful
     */
    bool setDate(uint16_t year, uint8_t month, uint8_t day);

    /**
     * set the time of the internal clock
     *
     * @param hour hour
     * @param minute minute
     * @param second second
     * @return true if successful
     */
    bool setTime(uint8_t hour, uint8_t minute, uint8_t second);

    /**
     * set the alarm
     *
     * @param hour hour
     * @param minute minute
     * @param second second
     * @return true if successful
     */
    bool setAlarm(uint8_t hour, uint8_t minute, uint8_t second);

    /**
     * clear any alarm that has been set
     *
     * @return true if successful
     */
    bool clearAlarm();

    /**
     * get the current volume
     *
     * @param vol the returned volume
     * @return true if successful
     */
    bool getVolume(uint8_t *vol);

    /**
     * get the current play state. 1 = playing, 2 = stopped, 3 = paused
     *
     * @param ps the returned play state
     * @return true if successful
     */
    bool getPlayState(uint8_t *ps);

    /**
     * get the number of files present on the source device
     *
     * @param psrc the storage source
     * @param numf the returned number of files
     * @return true if successful
     */
    bool getNumFiles(WT5001_PLAYSOURCE_T psrc, uint16_t *numf);

    /**
     * get the index of the current file
     *
     * @param curf the index of the current file
     * @return true if successful
     */
    bool getCurrentFile(uint16_t *curf);

    /**
     * get the device date
     *
     * @param year returned 4 digit year
     * @param month returned month
     * @param day returned day
     * @return true if successful
     */
    bool getDate(uint16_t *year, uint8_t *month, uint8_t *day);

    /**
     * get the device time
     *
     * @param hour returned hour
     * @param minute returned minute
     * @param second returned second
     * @return true if successful
     */
    bool getTime(uint8_t *hour, uint8_t *minute, uint8_t *second);


  protected:
    int ttyFd() { return m_ttyFd; };
    int setTtyFd(int fd) { m_ttyFd = fd; };

  private:
    mraa_uart_context m_uart;
    int m_ttyFd;
  };
}