src/lib/disk_writer_messages.h

   1 /*
   2     Copyright (C) 2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic 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     DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /* We have the front-end application dcpomatic2_disk and the back-end
  22  * dcpomatic2_disk_writer.  The communication is line-based, separated
  23  * by \n.
  24  */
  25
  26 /* PING */
  27
  28 // Front-end sends:
  29
  30 #define DISK_WRITER_PING "P"
  31
  32 // Back-end responds
  33
  34 #define DISK_WRITER_PONG "O"
  35
  36 /* REQUEST TO WRITE DCP */
  37
  38 // Front-end sends:
  39
  40 #define DISK_WRITER_WRITE "W"
  41 // DCP pathname
  42 // Internal name of the drive to write to
  43
  44 // Back-end responds:
  45
  46 // everything is ok
  47 #define DISK_WRITER_OK "D"
  48
  49 // there was an error
  50 #define DISK_WRITER_ERROR "E"
  51 // Error message
  52 // Error number
  53
  54 // the drive is being formatted, 40% done
  55 #define DISK_WRITER_FORMAT_PROGRESS "F"
  56 // 0.4\n
  57
  58 // data is being copied, 30% done
  59 #define DISK_WRITER_COPY_PROGRESS "C"
  60 // 0.3\n
  61
  62 // data is being verified, 60% done
  63 #define DISK_WRITER_VERIFY_PROGRESS "V"
  64 // 0.6\n
  65
  66
  67 /* REQUEST TO QUIT */
  68
  69 // Front-end sends:
  70 #define DISK_WRITER_QUIT "Q"
  71
  72
  73 /* REQUEST TO UNMOUNT A DRIVE */
  74
  75 // Front-end sends:
  76 #define DISK_WRITER_UNMOUNT "U"
  77 // XML representation of Drive object to unmount
  78
  79 // Back-end responds:
  80 // DISK_WRITER_OK
  81 // or
  82 // DISK_WRITER_ERROR
  83