不韋 呂 / F746_MySoundMachine

Integrated program of 4 different kinds of application programs for processing sound signal. 4種類のサウンド信号処理を統合したプログラム．

Dependencies:   F746_GUI F746_SAI_IO FrequencyResponseDrawer SD_PlayerSkeleton UIT_FFT_Real

mbed_src_STM32F7/api/FileHandle.h@2:fcba17e3d573, 2016-09-26 (annotated)

Committer:
MikamiUitOpen
Date:
Mon Sep 26 07:07:05 2016 +0000
Revision:
2:fcba17e3d573
Parent:
mbed_src_STM/api/FileHandle.h@0:224dccbc4edd 
3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MikamiUitOpen 0:224dccbc4edd 1 /* mbed Microcontroller Library
MikamiUitOpen 0:224dccbc4edd 2 * Copyright (c) 2006-2013 ARM Limited
MikamiUitOpen 0:224dccbc4edd 3 *
MikamiUitOpen 0:224dccbc4edd 4 * Licensed under the Apache License, Version 2.0 (the "License");
MikamiUitOpen 0:224dccbc4edd 5 * you may not use this file except in compliance with the License.
MikamiUitOpen 0:224dccbc4edd 6 * You may obtain a copy of the License at
MikamiUitOpen 0:224dccbc4edd 7 *
MikamiUitOpen 0:224dccbc4edd 8 * http://www.apache.org/licenses/LICENSE-2.0
MikamiUitOpen 0:224dccbc4edd 9 *
MikamiUitOpen 0:224dccbc4edd 10 * Unless required by applicable law or agreed to in writing, software
MikamiUitOpen 0:224dccbc4edd 11 * distributed under the License is distributed on an "AS IS" BASIS,
MikamiUitOpen 0:224dccbc4edd 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
MikamiUitOpen 0:224dccbc4edd 13 * See the License for the specific language governing permissions and
MikamiUitOpen 0:224dccbc4edd 14 * limitations under the License.
MikamiUitOpen 0:224dccbc4edd 15 */
MikamiUitOpen 0:224dccbc4edd 16 #ifndef MBED_FILEHANDLE_H
MikamiUitOpen 0:224dccbc4edd 17 #define MBED_FILEHANDLE_H
MikamiUitOpen 0:224dccbc4edd 18
MikamiUitOpen 0:224dccbc4edd 19 typedef int FILEHANDLE;
MikamiUitOpen 0:224dccbc4edd 20
MikamiUitOpen 0:224dccbc4edd 21 #include <stdio.h>
MikamiUitOpen 0:224dccbc4edd 22
MikamiUitOpen 0:224dccbc4edd 23 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
MikamiUitOpen 0:224dccbc4edd 24 typedef int ssize_t;
MikamiUitOpen 0:224dccbc4edd 25 typedef long off_t;
MikamiUitOpen 0:224dccbc4edd 26
MikamiUitOpen 0:224dccbc4edd 27 #else
MikamiUitOpen 0:224dccbc4edd 28 # include <sys/types.h>
MikamiUitOpen 0:224dccbc4edd 29 #endif
MikamiUitOpen 0:224dccbc4edd 30
MikamiUitOpen 0:224dccbc4edd 31 namespace mbed {
MikamiUitOpen 0:224dccbc4edd 32
MikamiUitOpen 0:224dccbc4edd 33 /** An OO equivalent of the internal FILEHANDLE variable
MikamiUitOpen 0:224dccbc4edd 34 * and associated _sys_* functions.
MikamiUitOpen 0:224dccbc4edd 35 *
MikamiUitOpen 0:224dccbc4edd 36 * FileHandle is an abstract class, needing at least sys_write and
MikamiUitOpen 0:224dccbc4edd 37 * sys_read to be implmented for a simple interactive device.
MikamiUitOpen 0:224dccbc4edd 38 *
MikamiUitOpen 0:224dccbc4edd 39 * No one ever directly tals to/instanciates a FileHandle - it gets
MikamiUitOpen 0:224dccbc4edd 40 * created by FileSystem, and wrapped up by stdio.
MikamiUitOpen 0:224dccbc4edd 41 */
MikamiUitOpen 0:224dccbc4edd 42 class FileHandle {
MikamiUitOpen 0:224dccbc4edd 43
MikamiUitOpen 0:224dccbc4edd 44 public:
MikamiUitOpen 0:224dccbc4edd 45 /** Write the contents of a buffer to the file
MikamiUitOpen 0:224dccbc4edd 46 *
MikamiUitOpen 0:224dccbc4edd 47 * @param buffer the buffer to write from
MikamiUitOpen 0:224dccbc4edd 48 * @param length the number of characters to write
MikamiUitOpen 0:224dccbc4edd 49 *
MikamiUitOpen 0:224dccbc4edd 50 * @returns
MikamiUitOpen 0:224dccbc4edd 51 * The number of characters written (possibly 0) on success, -1 on error.
MikamiUitOpen 0:224dccbc4edd 52 */
MikamiUitOpen 0:224dccbc4edd 53 virtual ssize_t write(const void* buffer, size_t length) = 0;
MikamiUitOpen 0:224dccbc4edd 54
MikamiUitOpen 0:224dccbc4edd 55 /** Close the file
MikamiUitOpen 0:224dccbc4edd 56 *
MikamiUitOpen 0:224dccbc4edd 57 * @returns
MikamiUitOpen 0:224dccbc4edd 58 * Zero on success, -1 on error.
MikamiUitOpen 0:224dccbc4edd 59 */
MikamiUitOpen 0:224dccbc4edd 60 virtual int close() = 0;
MikamiUitOpen 0:224dccbc4edd 61
MikamiUitOpen 0:224dccbc4edd 62 /** Function read
MikamiUitOpen 0:224dccbc4edd 63 * Reads the contents of the file into a buffer
MikamiUitOpen 0:224dccbc4edd 64 *
MikamiUitOpen 0:224dccbc4edd 65 * @param buffer the buffer to read in to
MikamiUitOpen 0:224dccbc4edd 66 * @param length the number of characters to read
MikamiUitOpen 0:224dccbc4edd 67 *
MikamiUitOpen 0:224dccbc4edd 68 * @returns
MikamiUitOpen 0:224dccbc4edd 69 * The number of characters read (zero at end of file) on success, -1 on error.
MikamiUitOpen 0:224dccbc4edd 70 */
MikamiUitOpen 0:224dccbc4edd 71 virtual ssize_t read(void* buffer, size_t length) = 0;
MikamiUitOpen 0:224dccbc4edd 72
MikamiUitOpen 0:224dccbc4edd 73 /** Check if the handle is for a interactive terminal device.
MikamiUitOpen 0:224dccbc4edd 74 * If so, line buffered behaviour is used by default
MikamiUitOpen 0:224dccbc4edd 75 *
MikamiUitOpen 0:224dccbc4edd 76 * @returns
MikamiUitOpen 0:224dccbc4edd 77 * 1 if it is a terminal,
MikamiUitOpen 0:224dccbc4edd 78 * 0 otherwise
MikamiUitOpen 0:224dccbc4edd 79 */
MikamiUitOpen 0:224dccbc4edd 80 virtual int isatty() = 0;
MikamiUitOpen 0:224dccbc4edd 81
MikamiUitOpen 0:224dccbc4edd 82 /** Move the file position to a given offset from a given location.
MikamiUitOpen 0:224dccbc4edd 83 *
MikamiUitOpen 0:224dccbc4edd 84 * @param offset The offset from whence to move to
MikamiUitOpen 0:224dccbc4edd 85 * @param whence SEEK_SET for the start of the file, SEEK_CUR for the
MikamiUitOpen 0:224dccbc4edd 86 * current file position, or SEEK_END for the end of the file.
MikamiUitOpen 0:224dccbc4edd 87 *
MikamiUitOpen 0:224dccbc4edd 88 * @returns
MikamiUitOpen 0:224dccbc4edd 89 * new file position on success,
MikamiUitOpen 0:224dccbc4edd 90 * -1 on failure or unsupported
MikamiUitOpen 0:224dccbc4edd 91 */
MikamiUitOpen 0:224dccbc4edd 92 virtual off_t lseek(off_t offset, int whence) = 0;
MikamiUitOpen 0:224dccbc4edd 93
MikamiUitOpen 0:224dccbc4edd 94 /** Flush any buffers associated with the FileHandle, ensuring it
MikamiUitOpen 0:224dccbc4edd 95 * is up to date on disk
MikamiUitOpen 0:224dccbc4edd 96 *
MikamiUitOpen 0:224dccbc4edd 97 * @returns
MikamiUitOpen 0:224dccbc4edd 98 * 0 on success or un-needed,
MikamiUitOpen 0:224dccbc4edd 99 * -1 on error
MikamiUitOpen 0:224dccbc4edd 100 */
MikamiUitOpen 0:224dccbc4edd 101 virtual int fsync() = 0;
MikamiUitOpen 0:224dccbc4edd 102
MikamiUitOpen 0:224dccbc4edd 103 virtual off_t flen() {
MikamiUitOpen 0:224dccbc4edd 104 /* remember our current position */
MikamiUitOpen 0:224dccbc4edd 105 off_t pos = lseek(0, SEEK_CUR);
MikamiUitOpen 0:224dccbc4edd 106 if(pos == -1) return -1;
MikamiUitOpen 0:224dccbc4edd 107 /* seek to the end to get the file length */
MikamiUitOpen 0:224dccbc4edd 108 off_t res = lseek(0, SEEK_END);
MikamiUitOpen 0:224dccbc4edd 109 /* return to our old position */
MikamiUitOpen 0:224dccbc4edd 110 lseek(pos, SEEK_SET);
MikamiUitOpen 0:224dccbc4edd 111 return res;
MikamiUitOpen 0:224dccbc4edd 112 }
MikamiUitOpen 0:224dccbc4edd 113
MikamiUitOpen 0:224dccbc4edd 114 virtual ~FileHandle();
MikamiUitOpen 0:224dccbc4edd 115 };
MikamiUitOpen 0:224dccbc4edd 116
MikamiUitOpen 0:224dccbc4edd 117 } // namespace mbed
MikamiUitOpen 0:224dccbc4edd 118
MikamiUitOpen 0:224dccbc4edd 119 #endif