rtsputil.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:7k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: rtsputil.h,v 1.1.1.1.50.3 2004/07/09 01:48:00 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef _RTSPUTIL_H_
  50. #define _RTSPUTIL_H_
  51. /*
  52.  * Function: 
  53.  *  BinTo64
  54.  *
  55.  * Purpose:
  56.  * Encode binary data into text using 64 characters from
  57.  * the ANSI character set a base 64 values. Essentially
  58.  * encodes 24 bits (3 bytes) into 4 6-bit base64 characters.
  59.  *
  60.  * Parameters:
  61.  * pInBuf - pointer to buffer of binary data to be encoded
  62.  *              len - length of data to be encoded
  63.  *              pOutBuf - pointer to output buffer
  64.  *
  65.  * Returns:
  66.  * length of encoded buffer
  67.  *
  68.  * Notes: 
  69.  * The output buffer should be about 33% larger than the input
  70.  *         buffer to hold the encoded data. Text is broken up into
  71.  *              72 character lines.
  72.  */
  73. INT32 BinTo64(const BYTE* pInBuf, INT32 len, char* pOutBuf);
  74. /*
  75.  * Function: 
  76.  *  BinToURL64
  77.  *
  78.  * Purpose:
  79.  * Encode binary data into text using 64 characters from
  80.  * the ANSI character set a base 64 values. Essentially
  81.  * encodes 24 bits (3 bytes) into 4 6-bit base64 characters.
  82.  *
  83.  *              Note: This function differs from BinTo64 in that the '*' and
  84.  *              '!' characters are used instead of the "/" and "+" chars. 
  85.  *              This is useful if the encoded string is going to be used as
  86.  *              a URL parameter. The same BinFrom64 function can be used to
  87.  *              decode both encodings.
  88.  *
  89.  * Parameters:
  90.  * pInBuf - pointer to buffer of binary data to be encoded
  91.  *              len - length of data to be encoded
  92.  *              pOutBuf - pointer to output buffer
  93.  *
  94.  * Returns:
  95.  * length of encoded buffer
  96.  *
  97.  * Notes: 
  98.  * The output buffer should be about 33% larger than the input
  99.  *         buffer to hold the encoded data. Text is broken up into
  100.  *              72 character lines.
  101.  */
  102. INT32 BinToURL64(const BYTE* pInBuf, INT32 len, char* pOutBuf);
  103. /*
  104.  * Function:
  105.  * BinFrom64
  106.  *
  107.  * Purpose:
  108.  * Decode base 64 text back into binary.
  109.  *
  110.  * Parameters:
  111.  * pInBuf - pointer to buffer of encoded data
  112.  * len - length of data to be decoded
  113.  * pOutBuf - pointer to output buffer
  114.  *
  115.  * Returns:
  116.  * length of decoded buffer or -1 if invalid input
  117.  *
  118.  * Notes:
  119.  *
  120.  */
  121. INT32 BinFrom64(const char* pInBuf, INT32 len, BYTE* pOutBuf);
  122. /*
  123.  * Function:
  124.  * EncodeCString
  125.  *
  126.  * Purpose:
  127.  * Add escape ('') characters so strings containing
  128.  * control characters can be used as data without
  129.  * losing the control character interpretation.
  130.  *
  131.  * Parameters:
  132.  * pInString - C-style zero terminated string to encode
  133.  *
  134.  * Returns:
  135.  * Encoded string
  136.  *
  137.  */
  138. const char* EncodeCString(const char* pInString);
  139. /*
  140.  * Function: 
  141.  *  URLEscapeBuffer
  142.  *
  143.  * Purpose:
  144.  * URL-Escapes the input buffer, translating illegal URL
  145.  * characters into a % sign followed by the hex value of
  146.  * that character.
  147.  *
  148.  * Parameters:
  149.  * pInBuf - pointer to buffer of printable data to be encoded
  150.  *              len - length of data to be encoded
  151.  *              pOutBuf - pointer to output buffer
  152.  *
  153.  * Returns:
  154.  * length of encoded buffer
  155.  *
  156.  * Notes: 
  157.  * The output buffer should be 3 times larger than the input
  158.  *         buffer to hold the encoded data. Each illegal URL character
  159.  *              will be translated to 3 characters (i.e. @ -> %40). The
  160.  * output will not be NULL terminated.
  161.  */
  162. INT32 URLEscapeBuffer(const char* pInBuf, INT32 len, char* pOutBuf);
  163. /*
  164.  * Function: 
  165.  *  URLEscapeBuffer2
  166.  *
  167.  * Purpose:
  168.  *  See RFC 1738.  This function should do proper url escaping.
  169.  *
  170.  * Parameters:
  171.  * pInBuf - pointer to buffer of printable data to be encoded
  172.  *              len - length of data to be encoded
  173.  *              pOutBuf - pointer to output buffer
  174.  *
  175.  *              bReserved - Should reserved values be escaped in this string?
  176.  *
  177.  * Returns:
  178.  * length of encoded buffer
  179.  *
  180.  * Notes:
  181.  *  See RFC1738
  182.  * "Thus, only alphanumerics, the special characters "$-_.+!*'(),",
  183.  * and reserved characters used for their reserved purposes may be
  184.  * used unencoded within a URL."
  185.  *
  186.  * Reserved characters: ";", "/", "?", ":", "@", "=" and "&" 
  187.  *
  188.  */
  189. INT32 URLEscapeBuffer2(const char* pInBuf, INT32 len, char* pOutBuf, 
  190.        BOOL bReserved);
  191. /*
  192.  * Function:
  193.  * URLUnescapeBuffer
  194.  *
  195.  * Purpose:
  196.  * URL-Unescapes the input buffer, translating escaped 
  197.  * characters to their normal representation (i.e. %40 -> @).
  198.  *
  199.  * Parameters:
  200.  * pInBuf - pointer to buffer of escaped data
  201.  * len - length of data to be decoded
  202.  * pOutBuf - pointer to output buffer
  203.  *
  204.  * Returns:
  205.  * length of decoded buffer or -1 if invalid input
  206.  *
  207.  * Notes:
  208.  * The output buffer must be at least the same size as the 
  209.  * input buffer, to handle the case in which the input buffer
  210.  * contains no escaped characters. The output will not be NULL
  211.  * terminated.
  212.  */
  213. INT32 URLUnescapeBuffer(const char* pInBuf, INT32 len, char* pOutBuf);
  214. #endif /* _RTSPUTIL_H_ */