Merge pull request #322 from nbirkbeck/add-projection-bounds

Adding support for v2 equirect bounds (vr180).

Author: jamiesonpepper

spatialmedia/__main__.py

@@ -80,6 +80,16 @@ def main(main_args):
  " where w=CroppedAreaImageWidthPixels h=CroppedAreaImageHeightPixels "
  "f_w=FullPanoWidthPixels f_h=FullPanoHeightPixels "
  "x=CroppedAreaLeftPixels y=CroppedAreaTopPixels")
+ video_group.add_argument(
+ "-b",
+ "--bounds",
+ action="store",
+ default=None,
+ help=
+ "Equirect projection bounds for VR180. Must specify 4 integers "
+ "in the form of \"top:bottom:left:right\" where each integer is "
+ "a 0.32 fixed point value on the amount to crop from the corresponding "
+ "border")
  audio_group = parser.add_argument_group("Spatial Audio")
  audio_group.add_argument(
  "-a",
@@ -97,7 +107,7 @@ def main(main_args):
  console("Injecting metadata requires both an input file and output file.")
  return
 
- metadata = metadata_utils.Metadata(args.projection, args.stereo_mode)
+ metadata = metadata_utils.Metadata(args.projection, args.stereo_mode, args.bounds)
  if not args.v2:
  metadata.projection = None
  metadata.stereo_mode = None

spatialmedia/metadata_utils.py

@@ -95,9 +95,14 @@
 ]
 
 class Metadata(object):
- def __init__(self, projection=None, stereo_mode=None):
+ def __init__(self, projection=None, stereo_mode=None, bounds=None):
  self.projection = None if (not projection or projection == "none") else projection
  self.stereo_mode = None if (not stereo_mode or stereo_mode == "none") else stereo_mode
+ if bounds:
+ bounds = [max(0, min(int(b, 0), 0xFFFFFFFF)) for b in bounds.split(":")]
+ if len(bounds) != 4:
+ print("Error: input bounds is incorrectly specified")
+ self.bounds = bounds
  self.video = None
  self.audio = None
 
@@ -186,7 +191,7 @@ def mpeg4_add_spherical_xml_v1(mpeg4_file, in_fh, metadata):
  mpeg4_file.resize()
  return True
 
-def mpeg4_add_spherical_v2(mpeg4_file, in_fh, projection, stereo_mode):
+def mpeg4_add_spherical_v2(mpeg4_file, in_fh, projection, stereo_mode, bounds):
  for element in mpeg4_file.moov_box.contents:
  if element.name == mpeg.constants.TAG_TRAK:
  for sub_element in element.contents:
@@ -199,18 +204,20 @@ def mpeg4_add_spherical_v2(mpeg4_file, in_fh, projection, stereo_mode):
  in_fh.seek(position)
  if in_fh.read(4) == mpeg.constants.TAG_VIDE:
  ret = inject_spatial_video_v2_atoms(
- in_fh, sub_element, projection, stereo_mode)
+ in_fh, sub_element, projection, stereo_mode, bounds)
  mpeg4_file.resize()
  return ret
 
 
-def inject_spatial_video_v2_atoms(in_fh, video_media_atom, projection, stereo_mode):
+def inject_spatial_video_v2_atoms(in_fh, video_media_atom, projection, stereo_mode, bounds):
  """Adds spherical v2 boxes to an mpeg4 file for all video tracks.
 
  Args:
- mpeg4_file: mpeg4, Mpeg4 file structure to add metadata.
  in_fh: file handle, Source for uncached file contents.
- metadata: string, xml metadata to inject into spherical tag.
+ video_media_atom: parent media atom.
+ projection: the projection type.
+ stereo_mode: stereo mode (if 3d), else none.
+ bounds: equirect bounds.
  """
  for atom in video_media_atom.contents:
  if atom.name != mpeg.constants.TAG_MINF:
@@ -240,7 +247,7 @@ def inject_spatial_video_v2_atoms(in_fh, video_media_atom, projection, stereo_mo
  proj_atom.name = mpeg.constants.TAG_PROJ
 
  proj_atom.add(mpeg.sv3d.PRHDBox.create())
- proj_atom.add(mpeg.sv3d.EQUIBox.create())
+ proj_atom.add(mpeg.sv3d.EQUIBox.create(bounds=bounds))
 
  sv3d_atom = mpeg.container.Container(header_size=8)
  sv3d_atom.name = mpeg.constants.TAG_SV3D
@@ -465,7 +472,8 @@ def inject_mpeg4(input_file, output_file, metadata, console):
  console("Error failed to insert spherical data")
 
  if ((metadata.projection or metadata.stereo_mode)
- and not mpeg4_add_spherical_v2(mpeg4_file, in_fh, metadata.projection, metadata.stereo_mode)):
+ and not mpeg4_add_spherical_v2(mpeg4_file, in_fh, metadata.projection,
+ metadata.stereo_mode, metadata.bounds)):
  console("Error failed to insert spherical data v2")
 
  if metadata.audio:

spatialmedia/mpeg/sv3d.py

@@ -115,19 +115,19 @@ def load_content(self, in_fh):
 
 
 class EQUIBox(box.Box):
- def __init__(self):
+ def __init__(self, bounds=None):
  box.Box.__init__(self)
  self.name = constants.TAG_EQUI
  self.header_size = 8
- self.bounds_top = 0
- self.bounds_bottom = 0
- self.bounds_left = 0
- self.bounds_right = 0
+ self.bounds_top = bounds[0] if bounds else 0
+ self.bounds_bottom = bounds[1] if bounds else 0
+ self.bounds_left = bounds[2] if bounds else 0
+ self.bounds_right = bounds[3] if bounds else 0
  self.content_size = 20
 
  @staticmethod
- def create():
- return EQUIBox()
+ def create(bounds=None):
+ return EQUIBox(bounds)
 
  def print_box(self, console):
  """ Prints the contents of this box to console."""

spatialmedia_test.py

@@ -70,6 +70,26 @@ def test_inject_v2_equirect_mono(self):
  self.assertTrue(contents.find('PRHD') >= 0)
  self.assertTrue(contents.find('EQUI') >= 0)
  self.assertFalse(contents.find('ST3D') >= 0)
+ self.assertTrue(contents.find('Bounds Top: 0') >= 0)
+ self.assertTrue(contents.find('Bounds Bottom: 0') >= 0)
+ self.assertTrue(contents.find('Bounds Left: 0') >= 0)
+ self.assertTrue(contents.find('Bounds Right: 0') >= 0)
+
+ def test_inject_v2_equirect_mono_with_bounds(self):
+ contents = self.inject_metadata(['-i',
+ '--v2',
+ '--bounds', '0x1:-2:0x7FFFFFFF:32',
+ '--projection', 'equirectangular',
+ 'data/testsrc_320x240_h264.mp4',
+ f'{_OUTPUT_DIR}/equirect_mono.mp4'])
+ self.assertTrue(contents.find('SV3D') >= 0)
+ self.assertTrue(contents.find('PRHD') >= 0)
+ self.assertTrue(contents.find('EQUI') >= 0)
+ self.assertFalse(contents.find('ST3D') >= 0)
+ self.assertTrue(contents.find('Bounds Top: 1') >= 0)
+ self.assertTrue(contents.find('Bounds Bottom: 0') >= 0)
+ self.assertTrue(contents.find('Bounds Left: 2147483647') >= 0)
+ self.assertTrue(contents.find('Bounds Right: 32') >= 0)
 
  def test_inject_v2_equirect_mono_vp9(self):
  contents = self.inject_metadata(['-i',