AOMedia Codec SDK
lightfield_bitstream_parsing
1 /*
2  * Copyright (c) 2018, Alliance for Open Media. All rights reserved
3  *
4  * This source code is subject to the terms of the BSD 2 Clause License and
5  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6  * was not distributed with this source code in the LICENSE file, you can
7  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8  * Media Patent License 1.0 was not distributed with this source code in the
9  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10  */
11 
12 // Lightfield Bitstream Parsing
13 // ============================
14 //
15 // This is a lightfield bitstream parsing example. It takes an input file
16 // containing the whole compressed lightfield bitstream(ivf file) and a text
17 // file containing a stream of tiles to decode and then constructs and outputs
18 // a new bitstream that can be decoded by an AV1 decoder. The output bitstream
19 // contains reference frames(i.e. anchor frames), camera frame header, and
20 // tile list OBUs. num_references is the number of anchor frames coded at the
21 // beginning of the light field file. After running the lightfield encoder,
22 // run lightfield bitstream parsing:
23 // examples/lightfield_bitstream_parsing vase10x10.ivf vase_tile_list.ivf 4
24 // tile_list.txt
25 //
26 // The tile_list.txt is expected to be of the form:
27 // Frame <frame_index0>
28 // <image_index0> <anchor_index0> <tile_col0> <tile_row0>
29 // <image_index1> <anchor_index1> <tile_col1> <tile_row1>
30 // ...
31 // Frame <frame_index1)
32 // ...
33 //
34 // The "Frame" markers indicate a new render frame and thus a new tile list
35 // will be started and the old one flushed. The image_indexN, anchor_indexN,
36 // tile_colN, and tile_rowN identify an individual tile to be decoded and
37 // to use anchor_indexN anchor image for MCP.
38 
39 #include <stdio.h>
40 #include <stdlib.h>
41 #include <string.h>
42 
43 #include "aom/aom_decoder.h"
44 #include "aom/aom_encoder.h"
45 #include "aom/aom_integer.h"
46 #include "aom/aomdx.h"
47 #include "aom_dsp/bitwriter_buffer.h"
48 #include "common/tools_common.h"
49 #include "common/video_reader.h"
50 #include "common/video_writer.h"
51 
52 #define MAX_TILES 512
53 
54 static const char *exec_name;
55 
56 void usage_exit(void) {
57  fprintf(stderr, "Usage: %s <infile> <outfile> <num_references> <tile_list>\n",
58  exec_name);
59  exit(EXIT_FAILURE);
60 }
61 
62 #define ALIGN_POWER_OF_TWO(value, n) \
63  (((value) + ((1 << (n)) - 1)) & ~((1 << (n)) - 1))
64 
65 const int output_frame_width = 512;
66 const int output_frame_height = 512;
67 
68 // Spec:
69 // typedef struct {
70 // uint8_t anchor_frame_idx;
71 // uint8_t tile_row;
72 // uint8_t tile_col;
73 // uint16_t coded_tile_data_size_minus_1;
74 // uint8_t *coded_tile_data;
75 // } TILE_LIST_ENTRY;
76 
77 // Tile list entry provided by the application
78 typedef struct {
79  int image_idx;
80  int reference_idx;
81  int tile_col;
82  int tile_row;
83 } TILE_LIST_INFO;
84 
85 static int get_image_bps(aom_img_fmt_t fmt) {
86  switch (fmt) {
87  case AOM_IMG_FMT_I420: return 12;
88  case AOM_IMG_FMT_I422: return 16;
89  case AOM_IMG_FMT_I444: return 24;
90  case AOM_IMG_FMT_I42016: return 24;
91  case AOM_IMG_FMT_I42216: return 32;
92  case AOM_IMG_FMT_I44416: return 48;
93  default: die("Invalid image format");
94  }
95  return 0;
96 }
97 
98 void process_tile_list(const TILE_LIST_INFO *tiles, int num_tiles,
99  aom_codec_pts_t tl_pts, unsigned char **frames,
100  const size_t *frame_sizes, aom_codec_ctx_t *codec,
101  unsigned char *tl_buf, AvxVideoWriter *writer,
102  uint8_t output_frame_width_in_tiles_minus_1,
103  uint8_t output_frame_height_in_tiles_minus_1) {
104  unsigned char *tl = tl_buf;
105  struct aom_write_bit_buffer wb = { tl, 0 };
106  unsigned char *saved_obu_size_loc = NULL;
107  uint32_t tile_list_obu_header_size = 0;
108  uint32_t tile_list_obu_size = 0;
109  int num_tiles_minus_1 = num_tiles - 1;
110  int i;
111 
112  // Write the tile list OBU header that is 1 byte long.
113  aom_wb_write_literal(&wb, 0, 1); // forbidden bit.
114  aom_wb_write_literal(&wb, 8, 4); // tile list OBU: "1000"
115  aom_wb_write_literal(&wb, 0, 1); // obu_extension = 0
116  aom_wb_write_literal(&wb, 1, 1); // obu_has_size_field
117  aom_wb_write_literal(&wb, 0, 1); // reserved
118  tl++;
119  tile_list_obu_header_size++;
120 
121  // Write the OBU size using a fixed length_field_size of 4 bytes.
122  saved_obu_size_loc = tl;
123  // aom_wb_write_unsigned_literal(&wb, data, bits) requires that bits <= 32.
124  aom_wb_write_unsigned_literal(&wb, 0, 32);
125  tl += 4;
126  tile_list_obu_header_size += 4;
127 
128  // write_tile_list_obu()
129  aom_wb_write_literal(&wb, output_frame_width_in_tiles_minus_1, 8);
130  aom_wb_write_literal(&wb, output_frame_height_in_tiles_minus_1, 8);
131  aom_wb_write_literal(&wb, num_tiles_minus_1, 16);
132  tl += 4;
133  tile_list_obu_size += 4;
134 
135  // Write each tile's data
136  for (i = 0; i <= num_tiles_minus_1; i++) {
137  aom_tile_data tile_data = { 0, NULL, 0 };
138 
139  int image_idx = tiles[i].image_idx;
140  int ref_idx = tiles[i].reference_idx;
141  int tc = tiles[i].tile_col;
142  int tr = tiles[i].tile_row;
143 
144  // Reset bit writer to the right location.
145  wb.bit_buffer = tl;
146  wb.bit_offset = 0;
147 
148  size_t frame_size = frame_sizes[image_idx];
149  const unsigned char *frame = frames[image_idx];
150 
152  aom_codec_control_(codec, AV1_SET_DECODE_TILE_COL, tc);
153 
154  aom_codec_err_t aom_status =
155  aom_codec_decode(codec, frame, frame_size, NULL);
156  if (aom_status) die_codec(codec, "Failed to decode tile.");
157 
158  aom_codec_control_(codec, AV1D_GET_TILE_DATA, &tile_data);
159 
160  // Copy over tile info.
161  // uint8_t anchor_frame_idx;
162  // uint8_t tile_row;
163  // uint8_t tile_col;
164  // uint16_t coded_tile_data_size_minus_1;
165  // uint8_t *coded_tile_data;
166  uint32_t tile_info_bytes = 5;
167  aom_wb_write_literal(&wb, ref_idx, 8);
168  aom_wb_write_literal(&wb, tr, 8);
169  aom_wb_write_literal(&wb, tc, 8);
170  aom_wb_write_literal(&wb, (int)tile_data.coded_tile_data_size - 1, 16);
171  tl += tile_info_bytes;
172 
173  memcpy(tl, (uint8_t *)tile_data.coded_tile_data,
174  tile_data.coded_tile_data_size);
175  tl += tile_data.coded_tile_data_size;
176 
177  tile_list_obu_size +=
178  tile_info_bytes + (uint32_t)tile_data.coded_tile_data_size;
179  }
180 
181  // Write tile list OBU size.
182  size_t bytes_written = 0;
183  if (aom_uleb_encode_fixed_size(tile_list_obu_size, 4, 4, saved_obu_size_loc,
184  &bytes_written))
185  die_codec(codec, "Failed to encode the tile list obu size.");
186 
187  // Copy the tile list.
188  if (!aom_video_writer_write_frame(
189  writer, tl_buf, tile_list_obu_header_size + tile_list_obu_size,
190  tl_pts))
191  die_codec(codec, "Failed to copy compressed tile list.");
192 }
193 
194 int main(int argc, char **argv) {
195  aom_codec_ctx_t codec;
196  AvxVideoReader *reader = NULL;
197  AvxVideoWriter *writer = NULL;
198  const AvxInterface *decoder = NULL;
199  const AvxVideoInfo *info = NULL;
200  int num_references;
201  int i;
202  aom_codec_pts_t pts;
203  const char *tile_list_file = NULL;
204 
205  exec_name = argv[0];
206  if (argc != 5) die("Invalid number of arguments.");
207 
208  reader = aom_video_reader_open(argv[1]);
209  if (!reader) die("Failed to open %s for reading.", argv[1]);
210 
211  num_references = (int)strtol(argv[3], NULL, 0);
212  info = aom_video_reader_get_info(reader);
213 
214  aom_video_reader_set_fourcc(reader, AV1_FOURCC);
215 
216  // The writer to write out ivf file in tile list OBU, which can be decoded by
217  // AV1 decoder.
218  writer = aom_video_writer_open(argv[2], kContainerIVF, info);
219  if (!writer) die("Failed to open %s for writing", argv[2]);
220 
221  tile_list_file = argv[4];
222 
223  decoder = get_aom_decoder_by_fourcc(info->codec_fourcc);
224  if (!decoder) die("Unknown input codec.");
225  printf("Using %s\n", aom_codec_iface_name(decoder->codec_interface()));
226 
227  if (aom_codec_dec_init(&codec, decoder->codec_interface(), NULL, 0))
228  die_codec(&codec, "Failed to initialize decoder.");
229 
230  // Decode anchor frames.
232 
233  printf("Reading %d reference images.\n", num_references);
234  for (i = 0; i < num_references; ++i) {
235  aom_video_reader_read_frame(reader);
236 
237  size_t frame_size = 0;
238  const unsigned char *frame =
239  aom_video_reader_get_frame(reader, &frame_size);
240  pts = (aom_codec_pts_t)aom_video_reader_get_frame_pts(reader);
241 
242  // Copy references bitstream directly.
243  if (!aom_video_writer_write_frame(writer, frame, frame_size, pts))
244  die_codec(&codec, "Failed to copy compressed anchor frame.");
245 
246  if (aom_codec_decode(&codec, frame, frame_size, NULL))
247  die_codec(&codec, "Failed to decode frame.");
248  }
249 
250  // Decode camera frames.
253 
254  FILE *infile = aom_video_reader_get_file(reader);
255  // Record the offset of the first camera image.
256  const FileOffset camera_frame_pos = ftello(infile);
257 
258  printf("Loading compressed frames into memory.\n");
259 
260  // Count the frames in the lightfield.
261  int num_frames = 0;
262  while (aom_video_reader_read_frame(reader)) {
263  ++num_frames;
264  }
265  if (num_frames < 1) die("Input light field has no frames.");
266 
267  // Read all of the lightfield frames into memory.
268  unsigned char **frames =
269  (unsigned char **)malloc(num_frames * sizeof(unsigned char *));
270  size_t *frame_sizes = (size_t *)malloc(num_frames * sizeof(size_t));
271  // Seek to the first camera image.
272  fseeko(infile, camera_frame_pos, SEEK_SET);
273  for (int f = 0; f < num_frames; ++f) {
274  aom_video_reader_read_frame(reader);
275  size_t frame_size = 0;
276  const unsigned char *frame =
277  aom_video_reader_get_frame(reader, &frame_size);
278  frames[f] = (unsigned char *)malloc(frame_size * sizeof(unsigned char));
279  memcpy(frames[f], frame, frame_size);
280  frame_sizes[f] = frame_size;
281  }
282  printf("Read %d frames.\n", num_frames);
283 
284  // Copy first camera frame for getting camera frame header. This is done
285  // only once.
286  {
287  size_t frame_size = frame_sizes[0];
288  const unsigned char *frame = frames[0];
289  pts = num_references;
290  aom_tile_data frame_header_info = { 0, NULL, 0 };
291 
292  // Need to decode frame header to get camera frame header info. So, here
293  // decoding 1 tile is enough.
295  aom_codec_control_(&codec, AV1_SET_DECODE_TILE_COL, 0);
296 
297  aom_codec_err_t aom_status =
298  aom_codec_decode(&codec, frame, frame_size, NULL);
299  if (aom_status) die_codec(&codec, "Failed to decode tile.");
300 
301  aom_codec_control_(&codec, AV1D_GET_FRAME_HEADER_INFO, &frame_header_info);
302 
303  size_t obu_size_offset =
304  (uint8_t *)frame_header_info.coded_tile_data - frame;
305  size_t length_field_size = frame_header_info.coded_tile_data_size;
306  // Remove ext-tile tile info.
307  uint32_t frame_header_size = (uint32_t)frame_header_info.extra_size - 1;
308  size_t bytes_to_copy =
309  obu_size_offset + length_field_size + frame_header_size;
310 
311  unsigned char *frame_hdr_buf = (unsigned char *)malloc(bytes_to_copy);
312  if (frame_hdr_buf == NULL)
313  die_codec(&codec, "Failed to allocate frame header buffer.");
314 
315  memcpy(frame_hdr_buf, frame, bytes_to_copy);
316 
317  // Update frame header OBU size.
318  size_t bytes_written = 0;
319  if (aom_uleb_encode_fixed_size(
320  frame_header_size, length_field_size, length_field_size,
321  frame_hdr_buf + obu_size_offset, &bytes_written))
322  die_codec(&codec, "Failed to encode the tile list obu size.");
323 
324  // Copy camera frame header bitstream.
325  if (!aom_video_writer_write_frame(writer, frame_hdr_buf, bytes_to_copy,
326  pts))
327  die_codec(&codec, "Failed to copy compressed camera frame header.");
328  free(frame_hdr_buf);
329  }
330 
331  // Read out the image format.
332  aom_img_fmt_t ref_fmt = 0;
333  if (aom_codec_control(&codec, AV1D_GET_IMG_FORMAT, &ref_fmt))
334  die_codec(&codec, "Failed to get the image format");
335  const int bps = get_image_bps(ref_fmt);
336  if (!bps) die_codec(&codec, "Invalid image format.");
337  // read out the tile size.
338  unsigned int tile_size = 0;
339  if (aom_codec_control(&codec, AV1D_GET_TILE_SIZE, &tile_size))
340  die_codec(&codec, "Failed to get the tile size");
341  const unsigned int tile_width = tile_size >> 16;
342  const unsigned int tile_height = tile_size & 65535;
343  // Allocate a buffer to store tile list bitstream.
344  const size_t data_sz = MAX_TILES * ALIGN_POWER_OF_TWO(tile_width, 5) *
345  ALIGN_POWER_OF_TWO(tile_height, 5) * bps / 8;
346 
347  unsigned char *tl_buf = (unsigned char *)malloc(data_sz);
348  if (tl_buf == NULL) die_codec(&codec, "Failed to allocate tile list buffer.");
349 
350  aom_codec_pts_t tl_pts = num_references;
351  const uint8_t output_frame_width_in_tiles_minus_1 =
352  output_frame_width / tile_width - 1;
353  const uint8_t output_frame_height_in_tiles_minus_1 =
354  output_frame_height / tile_height - 1;
355 
356  printf("Reading tile list from file.\n");
357  char line[1024];
358  FILE *tile_list_fptr = fopen(tile_list_file, "r");
359  if (!tile_list_fptr) die_codec(&codec, "Failed to open tile list file.");
360  int num_tiles = 0;
361  TILE_LIST_INFO tiles[MAX_TILES];
362  while ((fgets(line, 1024, tile_list_fptr)) != NULL) {
363  if (line[0] == 'F' || num_tiles >= MAX_TILES) {
364  // Flush existing tile list and start another, either because we hit a
365  // new render frame or because we've hit our max number of tiles per list.
366  if (num_tiles > 0) {
367  process_tile_list(tiles, num_tiles, tl_pts, frames, frame_sizes, &codec,
368  tl_buf, writer, output_frame_width_in_tiles_minus_1,
369  output_frame_height_in_tiles_minus_1);
370  ++tl_pts;
371  }
372  num_tiles = 0;
373  }
374  if (line[0] == 'F') {
375  continue;
376  }
377  if (sscanf(line, "%d %d %d %d", &tiles[num_tiles].image_idx,
378  &tiles[num_tiles].reference_idx, &tiles[num_tiles].tile_col,
379  &tiles[num_tiles].tile_row) == 4) {
380  if (tiles[num_tiles].image_idx >= num_frames) {
381  die("Tile list image_idx out of bounds: %d >= %d.",
382  tiles[num_tiles].image_idx, num_frames);
383  }
384  if (tiles[num_tiles].reference_idx >= num_references) {
385  die("Tile list reference_idx out of bounds: %d >= %d.",
386  tiles[num_tiles].reference_idx, num_references);
387  }
388  ++num_tiles;
389  }
390  }
391  if (num_tiles > 0) {
392  // Flush out the last tile list.
393  process_tile_list(tiles, num_tiles, tl_pts, frames, frame_sizes, &codec,
394  tl_buf, writer, output_frame_width_in_tiles_minus_1,
395  output_frame_height_in_tiles_minus_1);
396  ++tl_pts;
397  }
398 
399  const int num_tile_lists = (int)(tl_pts - pts);
400  printf("Finished processing tile lists. Num tile lists: %d.\n",
401  num_tile_lists);
402  free(tl_buf);
403  for (int f = 0; f < num_frames; ++f) {
404  free(frames[f]);
405  }
406  free(frame_sizes);
407  free(frames);
408  if (aom_codec_destroy(&codec)) die_codec(&codec, "Failed to destroy codec");
409  aom_video_writer_close(writer);
410  aom_video_reader_close(reader);
411 
412  return EXIT_SUCCESS;
413 }
AOM_IMG_FMT_I420
@ AOM_IMG_FMT_I420
Definition: aom_image.h:45
aom_tile_data::extra_size
size_t extra_size
Definition: aomdx.h:89
aom_codec_decode
aom_codec_err_t aom_codec_decode(aom_codec_ctx_t *ctx, const uint8_t *data, size_t data_sz, void *user_priv)
Decode data.
aom_img_fmt_t
enum aom_img_fmt aom_img_fmt_t
List of supported image formats.
AOM_IMG_FMT_I444
@ AOM_IMG_FMT_I444
Definition: aom_image.h:50
aom_tile_data::coded_tile_data_size
size_t coded_tile_data_size
Definition: aomdx.h:85
aom_tile_data::coded_tile_data
const void * coded_tile_data
Definition: aomdx.h:87
aom_codec_ctx
Codec context structure.
Definition: aom_codec.h:204
AV1_SET_TILE_MODE
@ AV1_SET_TILE_MODE
Definition: aomdx.h:196
AOM_IMG_FMT_I422
@ AOM_IMG_FMT_I422
Definition: aom_image.h:49
aom_codec_control_
aom_codec_err_t aom_codec_control_(aom_codec_ctx_t *ctx, int ctrl_id,...)
Control algorithm.
aom_codec_iface_name
const char * aom_codec_iface_name(aom_codec_iface_t *iface)
Return the name for a given interface.
AV1_SET_DECODE_TILE_ROW
@ AV1_SET_DECODE_TILE_ROW
Definition: aomdx.h:190
aom_codec_destroy
aom_codec_err_t aom_codec_destroy(aom_codec_ctx_t *ctx)
Destroy a codec instance.
AV1D_GET_FRAME_HEADER_INFO
@ AV1D_GET_FRAME_HEADER_INFO
Definition: aomdx.h:200
aom_codec_control
#define aom_codec_control(ctx, id, data)
aom_codec_control wrapper macro
Definition: aom_codec.h:414
AOM_IMG_FMT_I42216
@ AOM_IMG_FMT_I42216
Definition: aom_image.h:53
AOM_IMG_FMT_I44416
@ AOM_IMG_FMT_I44416
Definition: aom_image.h:54
aom_codec_pts_t
int64_t aom_codec_pts_t
Time Stamp Type.
Definition: aom_encoder.h:86
aom_codec_err_t
aom_codec_err_t
Algorithm return codes.
Definition: aom_codec.h:101
aom_decoder.h
Describes the decoder algorithm interface to applications.
aom_encoder.h
Describes the encoder algorithm interface to applications.
AV1D_GET_TILE_DATA
@ AV1D_GET_TILE_DATA
Definition: aomdx.h:204
aom_codec_dec_init
#define aom_codec_dec_init(ctx, iface, cfg, flags)
Convenience macro for aom_codec_dec_init_ver()
Definition: aom_decoder.h:135
AOM_IMG_FMT_I42016
@ AOM_IMG_FMT_I42016
Definition: aom_image.h:51
AV1D_GET_IMG_FORMAT
@ AV1D_GET_IMG_FORMAT
Definition: aomdx.h:139
AV1D_EXT_TILE_DEBUG
@ AV1D_EXT_TILE_DEBUG
Definition: aomdx.h:213
aomdx.h
Provides definitions for using AOM or AV1 within the aom Decoder interface.
aom_tile_data
Structure to hold a tile's start address and size in the bitstream.
Definition: aomdx.h:83
AV1D_GET_TILE_SIZE
@ AV1D_GET_TILE_SIZE
Definition: aomdx.h:142