StreamFile.h

00001 //           ///          //                                  C++ Cross Platform
00002 //          /////        ////
00003 //         /// XXX     XXX ///            ///////////   /////////     ///   ///
00004 //        ///    XXX XXX    ///         ///             ///    ///   ///  ///
00005 //       ///       XXX       ///         /////////     ///      //  //////
00006 //      ///      XXX XXX      ///               ///   ///    ///   ///  ///
00007 //     ////    XXX     XXX    ////    ////////////  //////////    ///   ///
00008 //    ////                     ////
00009 //   ////  M  O  B  O  T  I  X  ////////////////////////////////////////////////
00010 //  //// Security Vision Systems //////////////////////////////////////////////
00011 //
00012 //  $Author: khe_admin $
00013 //  $LastChangedBy: khe_admin $
00014 //  $LastChangedDate: 2007-06-29 15:34:53 +0200 (Fri, 29 Jun 2007) $
00015 //  $HeadURL: http://svn.mobotix.net/svn/mxsdk/src/IOKitComponent/trunk/include/StreamFile.h $
00016 //
00018      //
00019      //  MOBOTIX MxPEG SDK
00020      //
00021      //  This file belongs to the C++ library released as part of the MxPEG SDK.
00022      //
00023      //  This software is licenced under the BSD licence,
00024      //  http://www.opensource.org/licenses/bsd-license.php
00025      //
00026      //  Copyright (c) 2005 - 2007, MOBOTIX AG
00027      //  All rights reserved.
00028      //
00029      //  Redistribution and use in source and binary forms, with or without
00030      //  modification, are permitted provided that the following conditions are
00031      //  met:
00032      //
00033      //  - Redistributions of source code must retain the above copyright
00034      //    notice, this list of conditions and the following disclaimer.
00035      //
00036      //  - Redistributions in binary form must reproduce the above copyright
00037      //    notice, this list of conditions and the following disclaimer in the
00038      //    documentation and/or other materials provided with the distribution.
00039      //
00040      //  - Neither the name of MOBOTIX AG nor the names of its contributors may
00041      //    be used to endorse or promote products derived from this software
00042      //    without specific prior written permission.
00043      //
00044      //  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00045      //  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00046      //  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00047      //  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
00048      //  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00049      //  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00050      //  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00051      //  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00052      //  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00053      //  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00054      //  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00055      //
00057 
00058 
00059 
00060 #ifndef __MX_STREAMFILE_H__
00061 #define __MX_STREAMFILE_H__
00062 
00063 
00064 
00065 #define MX_STREAMFILE_ID "StreamFile"
00066 
00067 
00068 
00069 #include <interfaces/IComponent.h>
00070 #include <interfaces/IComponentInvoker.h>
00071 #include <interfaces/IStreamSourceFile.h>
00072 #include <interfaces/IStreamReceiver.h>
00073 
00074 #include <Framework/Framework.h>
00075 
00076 #include <mxm/core/mxmObject.h>
00077 
00078 
00079 
00080 namespace mx {
00081    
00084 
00115    class StreamFile : public mxmObject,
00116                       public virtual IComponent,
00117                       public virtual IStreamSourceFile,
00118                       public virtual IStreamReceiver    {
00119       
00123     private:
00124       static mxm::smart<mxmStringList> _enumerateInterfaces() {
00125          return(new mxmStringList((mxmString(MX_STREAMFILE_ID),
00126                                    MX_ICOMPONENT_ID,
00127                                    MX_ISTREAMSOURCEFILE_ID,
00128                                    MX_ISUPPORTSFILESPECIFICATION_ID,
00129                                    MX_ISTREAMSOURCE_ID,
00130                                    MX_IREQUIRESACTIVATION_ID,
00131                                    MX_ISTREAMRECEIVER_ID,
00132                                    MX_ISUPPORTSSHUTTINGDOWN_ID,
00133                                    MX_IERRORSTATE_ID)));
00134       }
00135       static mxm::smart<mxmStringList> _enumerateCapabilities(
00136                                           const mxmString &interface) {
00137          if(interface == mx::Framework::IdHintKey)
00138           return(new mxmStringList(MX_STREAMFILE_ID));
00139          else
00140           return(new mxmStringList());
00141       }
00142       
00143     private:
00144       class Invoker : public mxmObject, public virtual IComponentInvoker {
00145        public:
00146          mxm::smart<mxmStringList> enumerateInterfaces() {
00147             return(_enumerateInterfaces());
00148          }
00149          mxm::smart<mxmStringList> enumerateCapabilities(
00150                                      const mxmString &interface) {
00151             return(_enumerateCapabilities(interface));
00152          }
00153          IComponent *newComponent() {
00154             return(new StreamFile());
00155          }
00156       };
00157     public:
00159       static IComponentInvoker *newInvoker() {
00160          return(new Invoker());
00161       }
00162       
00163     private:
00164       mxmString Filename;
00165       int FileDescriptor;
00166       bool WriteMode;
00167       bool Online;
00168       
00169       int FD;
00170       bool StillUp;
00171       bool ErrorEncountered;
00172       bool HasBeenShutDown;
00173       bool CloseFileUponDestruction;
00174 #ifdef MX_PLATFORM_WINDOWS
00175       int RestoreMode;
00176       long OSFHandle;
00177 #endif
00178       bool TimedBlockMode;
00179       long BlockTimeout;
00180       
00181     public:
00182       StreamFile();
00183       ~StreamFile();
00184 
00185     public:
00187       mxm::smart<mxmStringList> enumerateInterfaces() {
00188          return(_enumerateInterfaces());
00189       }
00191       mxm::smart<mxmStringList> enumerateCapabilities(
00192                                    const mxmString &interface) {
00193          return(_enumerateCapabilities(interface));
00194       }
00195       
00197       void setFilename(const mxmString &filename);
00199       void setFileDescriptor(int fd);
00202       void setWriteMode(bool enabled);
00203       
00205       void setTimedBlockModeEnabled(bool enabled, long timeout = 1000);
00206       
00208       int fetchStreamBytes(mxm::u8 *buffer, int num);
00210       bool stillUp(void);
00211       
00213       void receiveStreamBytes(const mxm::u8 *bytes, int byte_num);
00214       
00216       bool errorState();
00218       void setErrorState();
00220       void shutdown();
00221       
00223       bool activate();
00224       
00225      private:
00227       void closeFile();
00228    };
00229 };
00230 
00231 
00232 
00233 #endif   // __MX_STREAMFILE_H__

Generated on Fri Jun 29 17:21:04 2007 for MxPEG SDK by  doxygen 1.4.6