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// A file source that is a plain byte stream (rather than frames)
19// C++ header
20
21#ifndef _BYTE_STREAM_FILE_SOURCE_HH
22#define _BYTE_STREAM_FILE_SOURCE_HH
23
24#ifndef _FRAMED_FILE_SOURCE_HH
25#include "FramedFileSource.hh"
26#endif
27
28class ByteStreamFileSource: public FramedFileSource {
29public:
30 static ByteStreamFileSource* createNew(UsageEnvironment& env,
31 char const* fileName,
32 unsigned preferredFrameSize = 0,
33 unsigned playTimePerFrame = 0);
34 // "preferredFrameSize" == 0 means 'no preference'
35 // "playTimePerFrame" is in microseconds
36
37 static ByteStreamFileSource* createNew(UsageEnvironment& env,
38 FILE* fid,
39 unsigned preferredFrameSize = 0,
40 unsigned playTimePerFrame = 0);
41 // an alternative version of "createNew()" that's used if you already have
42 // an open file.
43
44 u_int64_t fileSize() const { return fFileSize; }
45 // 0 means zero-length, unbounded, or unknown
46
47 void seekToByteAbsolute(u_int64_t byteNumber, u_int64_t numBytesToStream = 0);
48 // if "numBytesToStream" is >0, then we limit the stream to that number of bytes, before treating it as EOF
49 void seekToByteRelative(int64_t offset, u_int64_t numBytesToStream = 0);
50 void seekToEnd(); // to force EOF handling on the next read
51
52protected:
53 ByteStreamFileSource(UsageEnvironment& env,
54 FILE* fid,
55 unsigned preferredFrameSize,
56 unsigned playTimePerFrame);
57 // called only by createNew()
58
59 virtual ~ByteStreamFileSource();
60
61 static void fileReadableHandler(ByteStreamFileSource* source, int mask);
62 void doReadFromFile();
63
64private:
65 // redefined virtual functions:
66 virtual void doGetNextFrame();
67 virtual void doStopGettingFrames();
68
69protected:
70 u_int64_t fFileSize;
71
72private:
73 unsigned fPreferredFrameSize;
74 unsigned fPlayTimePerFrame;
75 Boolean fFidIsSeekable;
76 unsigned fLastPlayTime;
77 Boolean fHaveStartedReading;
78 Boolean fLimitNumBytesToStream;
79 u_int64_t fNumBytesToStream; // used iff "fLimitNumBytesToStream" is True
80};
81
82#endif
83