src/fsk.h

   1 /*
   2     Copyright (C) 2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/fsk.h
  36  *  @brief FSK class
  37  */
  38
  39
  40 #include <stdint.h>
  41 #include <vector>
  42
  43
  44 namespace dcp {
  45
  46
  47 /** @class FSK
  48  *  @brief Create frequency-shift-keyed samples for encoding synchronization signals.
  49  *
  50  *  An array of data is given to a FSK object using set_data(), and on calling get()
  51  *  this data will be returned in a the D-Cinema FSK "format", sample by sample, starting
  52  *  with the MSB of the first byte in the data array.
  53  *
  54  */
  55 class FSK
  56 {
  57 public:
  58         FSK ();
  59
  60         void set_data (std::vector<bool> data);
  61
  62         /** @return the next sample as a 24-bit signed integer */
  63         int32_t get ();
  64
  65 private:
  66         std::vector<bool> _data;
  67         /** current offset into _data */
  68         int _data_position = 0;
  69         /** current sample number of the current bit (0-3) */
  70         int _sample_position = 0;
  71         /** polarity of the last bit to be written (false for -ve, true for +ve) */
  72         bool _last_polarity = false;
  73         /** value of the last bit to be written */
  74         bool _last_bit = false;
  75 };
  76
  77
  78 }
  79
  80