1/**********
2This library is free software; you can redistribute it and/or modify it under
3the terms of the GNU Lesser General Public License as published by the
4Free Software Foundation; either version 3 of the License, or (at your
5option) any later version. (See <http://www.gnu.org/copyleft/lesser.html>.)
6
7This library is distributed in the hope that it will be useful, but WITHOUT
8ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
9FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
10more details.
11
12You should have received a copy of the GNU Lesser General Public License
13along with this library; if not, write to the Free Software Foundation, Inc.,
1451 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15**********/
16// "liveMedia"
17// Copyright (c) 1996-2020 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
31class FramedSource: public MediaSource {
32public:
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,
42 afterGettingFunc* afterGettingFunc,
43 void* afterGettingClientData,
44 onCloseFunc* onCloseFunc,
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
61 Boolean isCurrentlyAwaitingData() const {return fIsCurrentlyAwaitingData;}
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
67protected:
68 FramedSource(UsageEnvironment& env); // abstract base class
69 virtual ~FramedSource();
70
71 virtual void doStopGettingFrames();
72
73protected:
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
82private:
83 // redefined virtual functions:
84 virtual Boolean isFramedSource() const;
85
86private:
87 afterGettingFunc* fAfterGettingFunc;
88 void* fAfterGettingClientData;
89 onCloseFunc* fOnCloseFunc;
90 void* fOnCloseClientData;
91
92 Boolean fIsCurrentlyAwaitingData;
93};
94
95#endif
96