pp_stream_parser_samsung.h

Go to the documentation of this file.

/* Copyright (c) 2015 Samsung Electronics. All rights reserved.
 */

/* From samsung/pp_stream_parser_samsung.idl,
 *   modified Mon Jun 22 14:25:37 2015.
 */

#ifndef PPAPI_C_SAMSUNG_PP_STREAM_PARSER_SAMSUNG_H_
#define PPAPI_C_SAMSUNG_PP_STREAM_PARSER_SAMSUNG_H_

#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/pp_var.h"
#include "ppapi/c/samsung/pp_media_codecs_samsung.h"
#include "ppapi/c/samsung/pp_media_common_samsung.h"

/**
 * @file
 *
 * This file defines the common part of
 * <code>PP[PB]_StreamParser_Samsung</code> interface.
 */


/**
 * @addtogroup Enums
 * @{
 */
/* Enum describing status of parser initialization. */
typedef enum {
  PP_PARSER_INIT_FAILED,
  PP_PARSER_INIT_OK
} PP_Parser_InitStatus;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Parser_InitStatus, 4);

/* The PP_FrameFlags enum contains frame constants.
 * This values can be OR'ed.
 */
typedef enum {
  PP_FRAMEFLAG_NONE = 0,
  PP_FRAMEFLAG_KEYFRAME = 1 << 0,
  PP_FRAMEFLAG_ENCRYPTED = 1 << 1
} PP_FrameFlags;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_FrameFlags, 4);

/* The PP_ParseResult enum contains status of parsing last buffer. */
typedef enum {
  PP_PARSE_ERROR = -1,
  PP_PARSE_IN_PROGRESS = 0,
  PP_PARSE_CONFIG_FOUND = 1,
  PP_PARSE_SAMPLES_FOUND = 2,
  PP_PARSE_FINISHED = 3
} PP_ParseResult;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_ParseResult, 4);
/**
 * @}
 */

/**
 * @addtogroup Structs
 * @{
 */
/* Width and height of video frame. */
struct PP_GFXSize {
  int32_t width;
  int32_t height;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_GFXSize, 8);

/* To describing rectangle, e.g. position and size. */
struct PP_GFXRect {
  int32_t x;
  int32_t y;
  int32_t width;
  int32_t height;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_GFXRect, 16);

/* Structure used to describing frame rate. */
struct PP_Rational {
  int32_t num;
  int32_t den;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Rational, 8);

/*
 * Structure describing audio stream configuration.
 * Old version, deprecated since version 0.10
 */
struct PP_SP_AudioDecoderConfig_0_9 {
  PP_AudioCodec_Type_Samsung codec;
  /* profile is optional, only for some codecs. */
  PP_AudioCodec_Profile_Samsung profile;
  PP_SampleFormat_Samsung sample_format;
  int32_t bits_per_channel;
  PP_ChannelLayout_Samsung channel_layout;
  int32_t samples_per_second;
  int32_t bytes_per_frame;
  PP_Bool is_encrypted;
  PP_MicrosecondsDelta seek_preroll;
  PP_MicrosecondsDelta codec_delay;
  /* |extra_data| is an extra information stored in the stream, and used
   * to transmitt for example initialization vector for encryption.
   * Its type is PP_VARTYPE_ARRAY_BUFFER or PP_VARTYPE_NULL in case when
   * there is no extra data.
   */
  struct PP_Var extra_data;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_SP_AudioDecoderConfig_0_9, 64);

/* Structure describing audio stream configuration
 */
struct PP_SP_AudioDecoderConfig {
  PP_AudioCodec_Type_Samsung codec;
  /* profile is optional, only for some codecs. */
  PP_AudioCodec_Profile_Samsung profile;
  PP_SampleFormat_Samsung sample_format;
  int32_t bits_per_channel;
  PP_ChannelLayout_Samsung channel_layout;
  int32_t samples_per_second;
  int32_t bytes_per_frame;
  int32_t bit_rate;
  /* number of bytes per packet if constant. */
  int32_t block_align;
  /* codec id - four-character code. */
  uint32_t codec_tag;
  PP_MicrosecondsDelta seek_preroll;
  PP_MicrosecondsDelta codec_delay;
  PP_Bool is_encrypted;
  int32_t padding;
  /* |extra_data| is an extra information stored in the stream, and used
   * to transmit for example initialization vector for encryption.
   * Its type is PP_VARTYPE_ARRAY_BUFFER or PP_VARTYPE_NULL in case when
   * there is no extra data.
   */
  struct PP_Var extra_data;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_SP_AudioDecoderConfig, 80);

/* Structure describing video stream configuration.
 * Old version, deprecated since version 0.10
 */
struct PP_SP_VideoDecoderConfig_0_9 {
  PP_VideoCodec_Type_Samsung codec;
  /* profile is optional, only for some codecs. */
  PP_VideoCodec_Profile_Samsung profile;
  PP_VideoFrame_Format_Samsung format;
  PP_Bool is_encrypted;
  struct PP_GFXRect visible_rect;
  struct PP_GFXSize coded_size;
  struct PP_GFXSize natural_size;
  /* |extra_data| is an extra information stored in the stream, and used
   * to transmit for example initialization vector for encryption.
   * Its type is PP_VARTYPE_ARRAY_BUFFER or PP_VARTYPE_NULL in case when
   * there is no extra data.
   */
  struct PP_Var extra_data;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_SP_VideoDecoderConfig_0_9, 64);

/* Structure describing video stream configuration.
 */
struct PP_SP_VideoDecoderConfig {
  PP_VideoCodec_Type_Samsung codec;
  /* profile is optional, only for some codecs. */
  PP_VideoCodec_Profile_Samsung profile;
  PP_VideoFrame_Format_Samsung format;
  /* codec id - four-character code. */
  uint32_t codec_tag;
  struct PP_GFXRect visible_rect;
  struct PP_GFXSize coded_size;
  struct PP_GFXSize natural_size;
  struct PP_Rational frame_rate;
  PP_Bool is_encrypted;
  int32_t padding;
  /* |extra_data| is an extra information stored in the stream, and used
   * to transmitt for example initialization vector for encryption.
   * Its type is PP_VARTYPE_ARRAY_BUFFER or PP_VARTYPE_NULL in case when
   * there is no extra data.
   */
  struct PP_Var extra_data;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_SP_VideoDecoderConfig, 80);

/* Structure describing frames [obsolete from 0.10 interface version].
 */
struct PP_Frames {
  /* Size of frame data */
  int32_t size;
  /* Does buffer contain key frame */
  PP_Bool is_key_frame;
  /* Decompression Timestamp */
  PP_MicrosecondsDelta dts;
  /* Presentation Timesatmp */
  PP_MicrosecondsDelta pts;
  /* Duration of given packet */
  PP_MicrosecondsDelta duration;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Frames, 32);

/*
 * Structure describing samples [valid from 0.10 interface version]
 */
struct PP_Sample {
  /** Size of sample data */
  uint32_t size;
  /*
   * Size in bytes of data to be skipped before applying the decryption.
   */
  uint32_t data_offset;
  /*
   * Frame flags.
   * This field will containing OR'ed values from PP_FrameFlags enum.
   */
  uint32_t flags;
  /*
   * For encrypted samples, it is necessary to provide information required
   * to decrypting it. For this case is necessary to provide:
   *
   * - |num_subsample| defines how many subsamples are provided in this sample.
   * - |subsamples| array of relations between clear and encrypted fragments.
   * - |iv_size| and |key_id_size| adequately describes the sizes of arrays |iv|
   * and |key_id|, which contains unique pair of Initialization Vector and key
   * id for this sample.
   *
   * Alternatively it is possible to provide global pair of key id and IV
   * for whole buffer (in appropriate NewBuffers method), this alternative
   * are taken in case of per sample pair are omitted.
   *
   * Mixing of global key id with local (per sample) IV (or vice versa) is
   * not allowed.
   * If sample isn't encrypted (corresponding bit in |flags| isn't set)
   * all above informations are ignored.
   */
  uint8_t num_subsamples;
  uint8_t iv_size;
  uint16_t key_id_size;
  struct PP_EncryptedSubsampleDescription *subsamples;
  /* Initialization Vector, described above */
  uint8_t *iv;
  uint8_t *key_id;
  int32_t padding;
  /* Decode Timestamp of this sample */
  PP_MicrosecondsDelta dts;
  /* Presentation Timesatmp */
  PP_MicrosecondsDelta pts;
  /* Duration of given packet */
  PP_MicrosecondsDelta duration;
};
/**
 * @}
 */

#endif  /* PPAPI_C_SAMSUNG_PP_STREAM_PARSER_SAMSUNG_H_ */