Dirac - A Video Codec

Created by the British Broadcasting Corporation.


setstdiomode.h

Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002 *
00003 * $Id: setstdiomode.h,v 1.3 2004/06/30 16:44:52 asuraparaju Exp $ $Name: Dirac_0_5_2 $
00004 *
00005 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00006 *
00007 * The contents of this file are subject to the Mozilla Public License
00008 * Version 1.1 (the "License"); you may not use this file except in compliance
00009 * with the License. You may obtain a copy of the License at
00010 * http://www.mozilla.org/MPL/
00011 *
00012 * Software distributed under the License is distributed on an "AS IS" basis,
00013 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
00014 * the specific language governing rights and limitations under the License.
00015 *
00016 * The Original Code is BBC Research and Development code.
00017 *
00018 * The Initial Developer of the Original Code is the British Broadcasting
00019 * Corporation.
00020 * Portions created by the Initial Developer are Copyright (C) 2004.
00021 * All Rights Reserved.
00022 *
00023 * Contributor(s):
00024 *
00025 * Alternatively, the contents of this file may be used under the terms of
00026 * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
00027 * Public License Version 2.1 (the "LGPL"), in which case the provisions of
00028 * the GPL or the LGPL are applicable instead of those above. If you wish to
00029 * allow use of your version of this file only under the terms of the either
00030 * the GPL or LGPL and not to allow others to use your version of this file
00031 * under the MPL, indicate your decision by deleting the provisions above
00032 * and replace them with the notice and other provisions required by the GPL
00033 * or LGPL. If you do not delete the provisions above, a recipient may use
00034 * your version of this file under the terms of any one of the MPL, the GPL
00035 * or the LGPL.
00036 * ***** END LICENSE BLOCK ***** */
00037 
00038 /*****************************************************************
00039 File setstdiomode.h
00040 
00041 Utility for setting the mode of stdin/stdout and cin/cout to either
00042 binary or text mode.
00043 
00044 The function actually changes the mode of stdin/out but since these
00045 use the same file id as cin/cout it changes the mode of those as well.
00046 
00047 This function is only really relevant to Windows OS. *nixes use binary
00048 IO mode all the time (there is no distinction beween binary and text mode).
00049 The function does nothing under *nixes.
00050 
00051 An argument is needed to control the mode. This is should be a
00052 platform independent type. I have used std::ios_base::openmode for this
00053 purpose. When a value of std::ios_base::binary is passed as a parameter
00054 then the stdio and cin/out streams are set to binary mode (on Windows OS).
00055 
00056 Return value: as _setmode function for Windows (-1 indicates error)
00057               0 for *nix (always succeeds)
00058 
00059 Original author: Tim Borer
00060 ****************************************************************/
00061 
00062 #ifndef dirac_utilities_setstdiomode
00063 #define dirac_utilities_setstdiomode
00064 
00065 #include <ios>      //Defines std::ios_base
00066 
00067 namespace dirac_vu { //dirac video utilities namespace
00068 
00069     int setstdinmode(std::ios_base::openmode);
00070     int setstdoutmode(std::ios_base::openmode);
00071 
00072 }  // end namespace dirac_vu
00073 
00074 #endif // dirac_utilities_setstdiomode

© 2004 British Broadcasting Corporation. Dirac code licensed under the Mozilla Public License (MPL) Version 1.1.
HTML documentation generated by Dimitri van Heesch's excellent Doxygen tool.