include/opencascade/Media_IFrameQueue.hxx

0001 // Created by: Kirill GAVRILOV
0002 // Copyright (c) 2019 OPEN CASCADE SAS
0003 //
0004 // This file is part of Open CASCADE Technology software library.
0005 //
0006 // This library is free software; you can redistribute it and/or modify it under
0007 // the terms of the GNU Lesser General Public License version 2.1 as published
0008 // by the Free Software Foundation, with special exception defined in the file
0009 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0010 // distribution for complete text of the license and disclaimer of any warranty.
0011 //
0012 // Alternatively, this file may be used under the terms of Open CASCADE
0013 // commercial license or contractual agreement.
0014
0015 #ifndef _Media_IFrameQueue_HeaderFile
0016 #define _Media_IFrameQueue_HeaderFile
0017
0018 #include <Media_Frame.hxx>
0019
0020 //! Interface defining frame queuing.
0021 class Media_IFrameQueue
0022 {
0023 public:
0024
0025   //! Lock the frame, e.g. take ownership on a single (not currently displayed) frame from the queue to perform decoding into.
0026   virtual Handle(Media_Frame) LockFrame() = 0;
0027
0028   //! Release previously locked frame, e.g. it can be displayed on the screen.
0029   virtual void ReleaseFrame (const Handle(Media_Frame)& theFrame) = 0;
0030 };
0031
0032 #endif // _Media_IFrameQueue_HeaderFile