live
FramedSource.hh
Go to the documentation of this file.
1 /**********
2 This library is free software; you can redistribute it and/or modify it under
3 the terms of the GNU Lesser General Public License as published by the
4 Free Software Foundation; either version 3 of the License, or (at your
5 option) any later version. (See <http://www.gnu.org/copyleft/lesser.html>.)
6 
7 This library is distributed in the hope that it will be useful, but WITHOUT
8 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
9 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
10 more details.
11 
12 You should have received a copy of the GNU Lesser General Public License
13 along with this library; if not, write to the Free Software Foundation, Inc.,
14 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 **********/
16 // "liveMedia"
17 // Copyright (c) 1996-2019 Live Networks, Inc. All rights reserved.
18 // Framed Sources
19 // C++ header
20 
21 #ifndef _FRAMED_SOURCE_HH
22 #define _FRAMED_SOURCE_HH
23 
24 #ifndef _NET_COMMON_H
25 #include "NetCommon.h"
26 #endif
27 #ifndef _MEDIA_SOURCE_HH
28 #include "MediaSource.hh"
29 #endif
30 
31 class FramedSource: public MediaSource {
32 public:
33  static Boolean lookupByName(UsageEnvironment& env, char const* sourceName,
34  FramedSource*& resultSource);
35 
36  typedef void (afterGettingFunc)(void* clientData, unsigned frameSize,
37  unsigned numTruncatedBytes,
38  struct timeval presentationTime,
39  unsigned durationInMicroseconds);
40  typedef void (onCloseFunc)(void* clientData);
41  void getNextFrame(unsigned char* to, unsigned maxSize,
43  void* afterGettingClientData,
45  void* onCloseClientData);
46 
47  static void handleClosure(void* clientData);
48  void handleClosure();
49  // This should be called (on ourself) if the source is discovered
50  // to be closed (i.e., no longer readable)
51 
52  void stopGettingFrames();
53 
54  virtual unsigned maxFrameSize() const;
55  // size of the largest possible frame that we may serve, or 0
56  // if no such maximum is known (default)
57 
58  virtual void doGetNextFrame() = 0;
59  // called by getNextFrame()
60 
62 
63  static void afterGetting(FramedSource* source);
64  // doGetNextFrame() should arrange for this to be called after the
65  // frame has been read (*iff* it is read successfully)
66 
67 protected:
68  FramedSource(UsageEnvironment& env); // abstract base class
69  virtual ~FramedSource();
70 
71  virtual void doStopGettingFrames();
72 
73 protected:
74  // The following variables are typically accessed/set by doGetNextFrame()
75  unsigned char* fTo; // in
76  unsigned fMaxSize; // in
77  unsigned fFrameSize; // out
78  unsigned fNumTruncatedBytes; // out
79  struct timeval fPresentationTime; // out
80  unsigned fDurationInMicroseconds; // out
81 
82 private:
83  // redefined virtual functions:
84  virtual Boolean isFramedSource() const;
85 
86 private:
91 
93 };
94 
95 #endif
unsigned char Boolean
Definition: Boolean.hh:25
virtual void doGetNextFrame()=0
Boolean fIsCurrentlyAwaitingData
Definition: FramedSource.hh:92
unsigned fDurationInMicroseconds
Definition: FramedSource.hh:80
void() afterGettingFunc(void *clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
Definition: FramedSource.hh:36
void() onCloseFunc(void *clientData)
Definition: FramedSource.hh:40
afterGettingFunc * fAfterGettingFunc
Definition: FramedSource.hh:87
onCloseFunc * fOnCloseFunc
Definition: FramedSource.hh:89
Boolean isCurrentlyAwaitingData() const
Definition: FramedSource.hh:61
unsigned fFrameSize
Definition: FramedSource.hh:77
static Boolean lookupByName(UsageEnvironment &env, char const *sourceName, FramedSource *&resultSource)
unsigned fMaxSize
Definition: FramedSource.hh:76
void getNextFrame(unsigned char *to, unsigned maxSize, afterGettingFunc *afterGettingFunc, void *afterGettingClientData, onCloseFunc *onCloseFunc, void *onCloseClientData)
FramedSource(UsageEnvironment &env)
virtual unsigned maxFrameSize() const
void * fAfterGettingClientData
Definition: FramedSource.hh:88
unsigned char * fTo
Definition: FramedSource.hh:75
void * fOnCloseClientData
Definition: FramedSource.hh:90
virtual void doStopGettingFrames()
virtual Boolean isFramedSource() const
void stopGettingFrames()
static void afterGetting(FramedSource *source)
struct timeval fPresentationTime
Definition: FramedSource.hh:79
void handleClosure()
unsigned fNumTruncatedBytes
Definition: FramedSource.hh:78
virtual ~FramedSource()