remoting/proto/video.proto

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // Protocol for video messages.
   6
   7 syntax = "proto2";
   8
   9 option optimize_for = LITE_RUNTIME;
  10
  11 package remoting;
  12
  13 message VideoPacketFormat {
  14   // Identifies how the image was encoded.
  15   enum Encoding {
  16     ENCODING_INVALID = -1;
  17     ENCODING_VERBATIM = 0;
  18     ENCODING_ZLIB = 1;
  19     ENCODING_VP8 = 2;
  20   };
  21
  22   // X,Y coordinates (in screen pixels) for origin of this update.
  23   optional int32 x = 1;
  24   optional int32 y = 2;
  25
  26   // Width, height (in screen pixels) for this update.
  27   optional int32 width = 3;
  28   optional int32 height = 4;
  29
  30   // The encoding used for this image update.
  31   optional Encoding encoding = 5 [default = ENCODING_INVALID];
  32
  33   // Width and height of the whole screen.
  34   optional int32 screen_width = 6;
  35   optional int32 screen_height = 7;
  36
  37   // Horizontal and vertical DPI of the screen. If either of these is zero or
  38   // unset, the corresponding DPI should be assumed to be 96 (Windows' default)
  39   optional int32 x_dpi = 8;
  40   optional int32 y_dpi = 9;
  41 }
  42
  43 // TODO(hclam): Remove this message once we can obtain dirty rects from libvpx.
  44 message Rect {
  45   optional int32 x = 1;
  46   optional int32 y = 2;
  47   optional int32 width = 3;
  48   optional int32 height = 4;
  49 }
  50
  51 message VideoPacket {
  52   // Bitmasks for use in the flags field below.
  53   //
  54   // The encoder may fragment one update into multiple partitions.
  55   // Each partition may be divided into multiple packets depending on
  56   // how the encoder outputs data. Thus, one update can logically
  57   // consist of multiple packets. The FIRST_PACKET and LAST_PACKET
  58   // flags are used to indicate the start and end of a partition. The
  59   // LAST_PARTITION flag is set for the last packet in the last
  60   // partition. Here are notable consequences:
  61   //  * Both FIRST_PACKET and LAST_PACKET may be set if an update is only
  62   //    one packet long.
  63   //  * The VideoPacketFormat is only supplied in a FIRST_PACKET.
  64   //  * LAST_PARTITION can be set only in packet that has LAST_PACKET set.
  65   //  * An local update cannot change format between a FIRST_PACKET and
  66   //    a LAST_PACKET.
  67   //  * All packets in one logical update must be processed in order, and
  68   //    packets may not be skipped.
  69   enum Flags {
  70     FIRST_PACKET = 1;
  71     LAST_PACKET = 2;
  72     LAST_PARTITION = 4;
  73   }
  74   optional int32 flags = 1 [default = 0];
  75
  76   // The sequence number of the partial data for updating a rectangle.
  77   optional int32 sequence_number = 2 [default = 0];
  78
  79   optional int32 timestamp = 3 [default = 0];
  80
  81   // This is provided on the first packet of the rectangle data, when
  82   // the flags has FIRST_PACKET set.
  83   optional VideoPacketFormat format = 4;
  84
  85   optional bytes data = 5;
  86
  87   // This field is only for VP8 to provide out-of-band information of dirty
  88   // rects.
  89   // TODO(hclam): Remove this field when we can obtain this information from
  90   // libvpx.
  91   repeated Rect dirty_rects = 6;
  92
  93   // Time in milliseconds spent in capturing this video frame.
  94   optional int32 capture_time_ms = 7;
  95
  96   // Time in milliseconds spent in encoding this video frame.
  97   optional int32 encode_time_ms = 8;
  98
  99   // The most recent sequence number received from the client on the event
 100   // channel.
 101   optional int64 client_sequence_number = 9;
 102 }