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 /* dcpomatic_disk_writer receives
  22
  23 DCP pathname\n
  24 Internal name of drive to write to\n
  25
  26    Then responds with one of the following.
  27 */
  28
  29 /** Write finished and everything was OK, e.g.
  30
  31 D\n
  32
  33 */
  34 #define DISK_WRITER_OK "D"
  35
  36 /** There was an error.  Following this will come
  37
  38 error message\n
  39 error number\n
  40
  41 e.g.
  42
  43 E\n
  44 Disc full\n
  45 42\n
  46
  47 */
  48 #define DISK_WRITER_ERROR "E"
  49
  50 /** The disk writer is formatting the drive.  It is not possible
  51  *  to give progress reports on this so the writer just tells us
  52  *  it's happening.  This is finished when DISK_WRITER_PROGRESS
  53  *  messages start arriving
  54  */
  55 #define DISK_WRITER_FORMATTING "F"
  56
  57 /** Some progress has been made in the main "copy" part of the task.
  58  *  Following this will come
  59
  60 progress as a float from 0 to 1\n
  61
  62 e.g.
  63
  64 P\n
  65 0.3\n
  66
  67 */
  68 #define DISK_WRITER_PROGRESS "P"
  69
  70 /** dcpomatic_disk_writer may also receive
  71
  72 Q\n
  73
  74 as a request to quit.
  75 */
  76 #define DISK_WRITER_QUIT "Q"
  77