src/Media/Media_IFrameQueue.hxx

   1 // Created by: Kirill GAVRILOV
   2 // Copyright (c) 2019 OPEN CASCADE SAS
   3 //
   4 // This file is part of Open CASCADE Technology software library.
   5 //
   6 // This library is free software; you can redistribute it and/or modify it under
   7 // the terms of the GNU Lesser General Public License version 2.1 as published
   8 // by the Free Software Foundation, with special exception defined in the file
   9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 // distribution for complete text of the license and disclaimer of any warranty.
  11 //
  12 // Alternatively, this file may be used under the terms of Open CASCADE
  13 // commercial license or contractual agreement.
  14
  15 #ifndef _Media_IFrameQueue_HeaderFile
  16 #define _Media_IFrameQueue_HeaderFile
  17
  18 #include <Media_Frame.hxx>
  19
  20 //! Interface defining frame queuing.
  21 class Media_IFrameQueue
  22 {
  23 public:
  24
  25   //! Lock the frame, e.g. take ownership on a single (not currently displayed) frame from the queue to perform decoding into.
  26   virtual Handle(Media_Frame) LockFrame() = 0;
  27
  28   //! Release previously locked frame, e.g. it can be displayed on the screen.
  29   virtual void ReleaseFrame (const Handle(Media_Frame)& theFrame) = 0;
  30 };
  31
  32 #endif // _Media_IFrameQueue_HeaderFile