sound.h

00001 /* University of York Robotics Laboratory PsiSwarm Library: Audio Driver using PIC coprocessor Source File
00002  * 
00003  * Copyright 2016 University of York
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. 
00006  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
00007  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS
00008  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
00009  * See the License for the specific language governing permissions and limitations under the License.
00010  *
00011  * File: pic.h
00012  *
00013  * (C) Dept. Electronics & Computer Science, University of York
00014  * James Hilder, Alan Millard, Alexander Horsfield, Homero Elizondo, Jon Timmis
00015  *
00016  * PsiSwarm Library Version: 0.8
00017  *
00018  * October 2016
00019  *
00020  *
00021  */
00022  
00023  
00024 #ifndef SOUND_H
00025 #define SOUND_H
00026 
00027 /**
00028  * Sound class
00029  * Functions that generate audio tones using the sound module on the PIC coprocessor, where used
00030  *
00031 */
00032 class Sound
00033 {
00034 public:
00035 
00036  /** Play a tune defined by the given null terminated string
00037   * @param tune - The tune to play
00038   */
00039 void play_audio_string(char * tune);
00040 
00041  /** Play a tune defined by the given string
00042   * @param tune - The tune to play
00043   * @param length - The number of characters in the string
00044   */
00045 void play_tune(char * tune, char length);
00046 char IF_check_pic_firmware(void);
00047 };
00048 #endif