t35.h

Go to the documentation of this file.
00001 /*
00002  * SpanDSP - a series of DSP components for telephony
00003  *
00004  * t35.h - ITU T.35 FAX non-standard facility 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 General Public License as published by
00014  * the Free Software Foundation; either version 2 of the License, or
00015  * (at your option) any later version.
00016  *
00017  * This program is distributed in the hope that it will be useful,
00018  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020  * GNU General Public License for more details.
00021  *
00022  * You should have received a copy of the GNU General Public License
00023  * along with this program; if not, write to the Free Software
00024  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00025  *
00026  * $Id: t35.h,v 1.5 2005/11/23 17:09:47 steveu Exp $
00027  */
00028 
00029 /*! \file */
00030 
00031 #if !defined(_T35_H_)
00032 #define _T35_H_
00033 
00034 /*! \page t35_page T.35 manufacturer specific processing for FAX machines
00035 \section t35_page_sec_1 What does it do?
00036 ???.
00037 
00038 \section t35_page_sec_2 How does it work?
00039 ???.
00040 */
00041 
00042 extern const char *t35_country_codes[256];
00043 
00044 #ifdef __cplusplus
00045 extern "C" {
00046 #endif
00047 
00048 /*! Decode an NSF field to try to determine the make and model of the
00049     remote machine.
00050     \brief Decode an NSF field.
00051     \param msg The NSF message.
00052     \param len The length of the NSF message.
00053     \param vendor A pointer which will be pointed to the identified vendor.
00054            If a NULL pointer is given, the vendor ID will not be returned.
00055            If the vendor is not identified, NULL will be returned.
00056     \param model A pointer which will be pointed to the identified model.
00057            If a NULL pointer is given, the model will not be returned.
00058            If the model is not identified, NULL will be returned.
00059     \return TRUE if the machine was identified, otherwise FALSE.
00060 */
00061 int t35_decode(const uint8_t *msg, int len, const char **vendor, const char **model);
00062 
00063 #ifdef __cplusplus
00064 }
00065 #endif
00066 
00067 #endif
00068 /*- End of file ------------------------------------------------------------*/

Generated on Fri Nov 10 09:40:24 2006 for libspandsp by  doxygen 1.5.1