vdr.h

   1 /*
   2     Copyright 2004-2020 Chris Tallon
   3
   4     This file is part of VOMP.
   5
   6     VOMP is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     VOMP is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with VOMP.  If not, see <https://www.gnu.org/licenses/>.
  18 */
  19
  20
  21 // FIXME - This and the protocol are overly complicated now. Sorry.
  22 //         I'll clean it up in a couple of releases time...
  23
  24
  25 #ifndef VDR_H
  26 #define VDR_H
  27
  28 #include <stdio.h>
  29 #include <time.h>
  30 #include <vector>
  31 #include <algorithm>
  32 #include <thread>
  33 #include <mutex>
  34 #include <memory>
  35
  36 #include "defines.h"
  37 #include "log.h"
  38 #include "rectimer.h"
  39 #include "mark.h"
  40 #ifdef VOMP_MEDIAPLAYER
  41 #include "mediaprovider.h"
  42 #endif
  43 #include "eventdispatcher.h"
  44 #include "i18n.h"
  45 #include "control.h"
  46 #include "tcp.h"
  47 #include "image.h"
  48
  49 class RecInfo;
  50 class Event;
  51 class Channel;
  52 class VDR_RequestPacket;
  53 class VDR_ResponsePacket;
  54 #ifdef VOMP_MEDIAPLAYER
  55 class SerializeBuffer;
  56 #endif
  57 class MovieInfo;
  58 class SeriesInfo;
  59
  60 typedef std::vector<Event*> EventList;
  61 typedef std::vector<Channel*> ChannelList;
  62 typedef std::vector<RecTimer*> RecTimerList;
  63
  64 struct RecTimerSorter     // : public binary_function<double, double, bool>
  65 {
  66   bool operator() (const RecTimer* a, const RecTimer* b)
  67   {
  68     return a->startTime < b->startTime;
  69   }
  70 };
  71
  72 class StreamReceiver
  73 {
  74   public:
  75     virtual void streamReceive(ULONG, void*, ULONG)=0;
  76 };
  77
  78 class VDR_PacketReceiver : public EDReceiver // implementation in vdr.cc
  79 {
  80   public:
  81     virtual void call(void* userTag, bool& r_deregisterEDR, bool& r_wakeThread, bool& r_deleteEDR);
  82
  83   friend class VDR;
  84   protected:
  85 //    ULONG requestTime;
  86     ULONG receiverChannel;
  87
  88     // If receiverChannel == 1:
  89     ULONG requestSerialNumber;      // set by RequestResponse, used in ed_cb_find
  90     VDR_ResponsePacket* save_vresp; // set by ed_cb_call, used in RequestResponse
  91
  92     // If receiverChannel == 2:
  93     ULONG streamID;
  94     StreamReceiver* streamReceiver;
  95 };
  96
  97 class RecMan;
  98
  99 class VDR : public EventDispatcher,
 100 #ifdef VOMP_MEDIAPLAYER
 101 public MediaProvider,
 102 #endif
 103 public ExternLogger
 104 {
 105
 106   public:
 107     const static ULONG VIDEO = 1;
 108     const static ULONG RADIO = 2;
 109
 110     const static ULONG CHANNEL_REQUEST_RESPONSE = 1;
 111     const static ULONG CHANNEL_STREAM = 2;
 112     const static ULONG CHANNEL_KEEPALIVE = 3;
 113     const static ULONG CHANNEL_NETLOG = 4;
 114     const static ULONG CHANNEL_TVMEDIA = 5;
 115
 116     VDR();
 117     ~VDR();
 118     static VDR* getInstance();
 119
 120     int init();
 121     int shutdown();
 122
 123     /*
 124     void findServers(std::vector<VDRServer>& servers);
 125     void cancelFindingServer();
 126     */
 127
 128     void setServerIP(const char*);
 129     void setServerPort(USHORT);
 130     void setReceiveWindow(size_t size);
 131     bool connect();
 132     void disconnect();
 133     void abortConnect(); // If there is one, force a running connect call to abort
 134     bool isConnected() { return connected; }
 135     int getChannelNumberWidth() { return channelNumberWidth; }
 136
 137     void setVDRShutdown(bool doShutdown) { doVDRShutdown = doShutdown; }
 138     void shutdownVDR();
 139
 140     // protocol functions
 141     // for the following, if result == false then the connection has died
 142     //  doLogin
 143     //  getRecordingList
 144     //  getChannelsList
 145     //  getChannelSchedule
 146     //  getRecTimersList
 147     // isConnected can be called after the following to determine if still ok
 148     //  deleteRecording
 149     //  streamRecording
 150     //  positionFromFrameNumber
 151     //  streamChannel
 152     //  getBlock
 153     //  stopStreaming
 154     //  configLoad
 155     //  configSave
 156     //  setEventTimer
 157
 158     bool          doLogin(unsigned int* v_server_min, unsigned int* v_server_max, unsigned int* v_client,  ASLPrefList& list, int &subtitles);
 159     bool          getRecordingsList(RecMan* recman);
 160     RecInfo*      getRecInfo(char* fileName);
 161     int           deleteRecording(char* fileName);
 162     int           deleteRecResume(char* fileName);
 163     char*         moveRecording(char* fileName, char* newPath);
 164     ULLONG        streamRecording(char* fileName, ULONG* lengthFrames, bool* IsPesRecording);
 165     ULLONG        positionFromFrameNumber(ULONG frameNumber);
 166     ULONG         frameNumberFromPosition(ULLONG position);
 167     bool          getNextIFrame(ULONG frameNumber, ULONG direction, ULLONG* rfilePosition, ULONG* rframeNumber, ULONG* rframeLength);
 168                   // Direction: 0=backwards, 1=forwards
 169     MarkList*     getMarks(char* fileName);
 170     int           deleteTimer(RecTimer* delTimer);
 171     std::shared_ptr<ChannelList> getChannelsList(ULONG type);
 172     int           streamChannel(ULONG number, StreamReceiver*);
 173     int           streamChannel(ULONG number);
 174     void          getChannelPids(Channel* channel);
 175     UCHAR*        getBlock(ULLONG position, UINT maxAmount, UINT* amountReceived);
 176                   //get image blocks separate - we can do this in parallel
 177     int           stopStreaming();
 178     EventList*    getChannelSchedule(ULONG number);
 179     EventList*    getChannelSchedule(ULONG number, time_t start, ULONG duration);
 180     int           configSave(const char* section, const char* key, const char* value);
 181     char*         configLoad(const char* section, const char* key);
 182     ULONG         setEventTimer(char* timerString);
 183     RecTimerList* getRecTimersList();
 184     bool          LogExtern(const char* buffer);
 185
 186     bool setCharset(int charset); // 1 latin 2 UTF-8
 187 #ifdef VOMP_MEDIAPLAYER
 188     /**
 189       * the MediaProvider functions
 190       *
 191       */
 192     virtual MediaList* getRootList();
 193     virtual MediaList* getMediaList(const MediaURI * parent);
 194     virtual int        openMedium(ULONG channel,const MediaURI *uri,ULLONG * size, ULONG xsize,ULONG ysize);
 195     virtual int getMediaBlock(ULONG channel, unsigned long long offset, unsigned long len, unsigned long * outlen,
 196         unsigned char ** buffer);
 197     virtual int getMediaInfo(ULONG channel, struct MediaInfo * result);
 198     virtual int closeMediaChannel(ULONG channel);
 199 #endif
 200
 201     //TV Scraper support
 202     void getScraperEventType(char * fileName, int & movieID, int & seriesID, int & episodeID);
 203     void getScraperEventType(UINT eventid, UINT channelid, int & movieID, int & seriesID, int & episodeID, int & epgImage);
 204     MovieInfo* getScraperMovieInfo(int movieID);
 205     SeriesInfo* getScraperSeriesInfo(int seriesID, int episodeID);
 206
 207     bool loadImageGeneric(ImageGeneric& image);
 208     bool loadImageRecThumb(ImageRecThumb& image);
 209     bool loadImageEventThumb(ImageEventThumb& image);
 210     bool loadImageChannelLogo(ImageChannelLogo& image);
 211
 212     I18n::lang_code_list getLanguageList();
 213     int           getLanguageContent(const std::string code, I18n::trans_table&);
 214
 215     // end protocol functions
 216
 217
 218     // obselete
 219     ULLONG     rescanRecording(ULONG* lengthFrames);                    // FIXME obselete
 220
 221
 222
 223   private:
 224     static VDR* instance;
 225
 226     VDR_ResponsePacket* RequestResponse(VDR_RequestPacket* request);
 227     UCHAR* getBlock(ULLONG position, UINT maxAmount, UINT* amountReceived, ULONG cmd);
 228
 229     void connectionDied();
 230     bool sendKA(ULONG timeStamp);
 231
 232     LogNT* logger;
 233     int initted{};
 234     int findingServer{};
 235     TCP tcp;
 236     char serverIP[40];
 237     USHORT serverPort;
 238     ULONG maxChannelNumber{};
 239     bool doVDRShutdown{};
 240     int channelNumberWidth{1};
 241     VDR_PacketReceiver* TEMP_SINGLE_VDR_PR;
 242
 243     std::mutex connectStateMutex; // FIXME improve this
 244     bool connecting{};
 245     bool disconnecting{};
 246     bool babortConnect{};
 247     bool connected{};
 248
 249     std::mutex threadStartProtect;
 250     std::thread vdrThread;
 251     bool threadReqStop{};
 252
 253 #ifdef VOMP_MEDIAPLAYER
 254     ULONG providerId;
 255     ULONG subRange;
 256     SerializeBuffer * doRequestResponse(SerializeBuffer *in,int cmd);
 257 #endif
 258   protected:
 259
 260     // Thread
 261     void threadMethod();
 262
 263     // EventDispatcher
 264     virtual bool ed_cb_find(EDReceiver* edr, void* userTag);
 265 };
 266
 267 #endif
 268
 269 /*
 270
 271 index.vdr file format for video:
 272
 273 For every video frame:
 274 {
 275   File offset    4 bytes
 276   Picture type   1 byte
 277   File number    1 byte
 278   Zero           2 bytes
 279 }
 280
 281 Picture types:
 282
 283 #define NO_PICTURE 0
 284 #define I_FRAME    1
 285 #define P_FRAME    2
 286 #define B_FRAME    3
 287
 288
 289
 290 Packet formats
 291
 292 Packet format for an RR channel request:
 293
 294 4 bytes = channel ID = 1 (request/response channel)
 295 4 bytes = request ID (from serialNumber)
 296 4 bytes = opcode
 297 4 bytes = length of the rest of the packet
 298 ? bytes = rest of packet. depends on packet
 299
 300
 301 Packet format for an RR channel response:
 302
 303 4 bytes = channel ID = 1 (request/response channel)
 304 4 bytes = request ID (from serialNumber)
 305 4 bytes = length of the rest of the packet
 306 ? bytes = rest of packet. depends on packet
 307
 308
 309 Packet format for a stream packet:
 310
 311 4 bytes = channel ID = 2 (stream channel)
 312 4 bytes = stream ID (from requestID)
 313 4 bytes = length of the stream data (rest of packet)
 314 ? bytes = stream data
 315
 316 */
 317