spandsp
0.0.6
|
00001 /* 00002 * SpanDSP - a series of DSP components for telephony 00003 * 00004 * t30_logging.h - definitions for T.30 fax processing 00005 * 00006 * Written by Steve Underwood <steveu@coppice.org> 00007 * 00008 * Copyright (C) 2003 Steve Underwood 00009 * 00010 * All rights reserved. 00011 * 00012 * This program is free software; you can redistribute it and/or modify 00013 * it under the terms of the GNU Lesser General Public License version 2.1, 00014 * as published by the Free Software Foundation. 00015 * 00016 * This program is distributed in the hope that it will be useful, 00017 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00018 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00019 * GNU Lesser General Public License for more details. 00020 * 00021 * You should have received a copy of the GNU Lesser General Public 00022 * License along with this program; if not, write to the Free Software 00023 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00024 */ 00025 00026 /*! \file */ 00027 00028 #if !defined(_SPANDSP_T30_LOGGING_H_) 00029 #define _SPANDSP_T30_LOGGING_H_ 00030 00031 #if defined(__cplusplus) 00032 extern "C" 00033 { 00034 #endif 00035 00036 /*! Return a text name for a T.30 frame type. 00037 \brief Return a text name for a T.30 frame type. 00038 \param x The frametype octet. 00039 \return A pointer to the text name for the frame type. If the frame type is 00040 not value, the string "???" is returned. */ 00041 SPAN_DECLARE(const char *) t30_frametype(uint8_t x); 00042 00043 /*! Decode a DIS, DTC or DCS frame, and log the contents. 00044 \brief Decode a DIS, DTC or DCS frame, and log the contents. 00045 \param s The T.30 context. 00046 \param dis A pointer to the frame to be decoded. 00047 \param len The length of the frame. */ 00048 SPAN_DECLARE(void) t30_decode_dis_dtc_dcs(t30_state_t *s, const uint8_t *dis, int len); 00049 00050 /*! Convert a phase E completion code to a short text description. 00051 \brief Convert a phase E completion code to a short text description. 00052 \param result The result code. 00053 \return A pointer to the description. */ 00054 SPAN_DECLARE(const char *) t30_completion_code_to_str(int result); 00055 00056 #if defined(__cplusplus) 00057 } 00058 #endif 00059 00060 #endif 00061 /*- End of file ------------------------------------------------------------*/