OpusExportProcessor::OggPacket Struct Reference

Collaboration diagram for OpusExportProcessor::OggPacket:

Public Types
using	byte_type = std::remove_pointer_t< decltype(ogg_packet::packet)>

Public Member Functions
	OggPacket (int64_t packetNo, bool resizable)
	OggPacket (int64_t packetNo)
	OggPacket (int64_t packetNo, long size, bool resizable)
void	Resize (long size)
void	Reset () noexcept
void	MarkBOS () noexcept
void	MarkEOS () noexcept
void	Write (const void *data, const long length)
template<typename IntType >
void	Write (IntType value)
byte_type *	GetBuffer ()
size_t	GetBufferSize () const

Public Attributes
ogg_packet	packet {}

Private Attributes
std::vector< byte_type >	buffer
bool	resizable { false }

Detailed Description

Definition at line 236 of file ExportOpus.cpp.

Member Typedef Documentation

byte_type

using OpusExportProcessor::OggPacket::byte_type = std::remove_pointer_t<decltype(ogg_packet::packet)>

Definition at line 238 of file ExportOpus.cpp.

Constructor & Destructor Documentation

OggPacket() [1/3]

OpusExportProcessor::OggPacket::OggPacket ( int64_t  packetNo, bool  resizable  )

inline

Definition at line 241 of file ExportOpus.cpp.

          : resizable { resizable }
      {
         packet.packetno = packetNo;
      }

References packet.

OggPacket() [2/3]

OpusExportProcessor::OggPacket::OggPacket ( int64_t  packetNo )

inlineexplicit

Definition at line 247 of file ExportOpus.cpp.

          : OggPacket { packetNo, false }
      {
      }

OggPacket() [3/3]

OpusExportProcessor::OggPacket::OggPacket ( int64_t  packetNo, long  size, bool  resizable  )

inline

Definition at line 252 of file ExportOpus.cpp.

          : OggPacket { packetNo, resizable }
      {
         Resize(size);
      }

References Resize(), and size.

Here is the call graph for this function:

Member Function Documentation

GetBuffer()

byte_type * OpusExportProcessor::OggPacket::GetBuffer ( )

inline

Definition at line 322 of file ExportOpus.cpp.

      {
         return buffer.data();
      }

References buffer.

GetBufferSize()

size_t OpusExportProcessor::OggPacket::GetBufferSize ( ) const

inline

Definition at line 327 of file ExportOpus.cpp.

      {
         return buffer.size();
      }

References buffer.

MarkBOS()

void OpusExportProcessor::OggPacket::MarkBOS ( )

inlinenoexcept

Definition at line 269 of file ExportOpus.cpp.

      {
         packet.b_o_s = 1;
      }

References packet.

Referenced by OpusExportProcessor::WriteOpusHeader().

Here is the caller graph for this function:

MarkEOS()

void OpusExportProcessor::OggPacket::MarkEOS ( )

inlinenoexcept

Definition at line 274 of file ExportOpus.cpp.

      {
         packet.e_o_s = 1;
      }

References packet.

Reset()

void OpusExportProcessor::OggPacket::Reset ( )

inlinenoexcept

Definition at line 264 of file ExportOpus.cpp.

      {
         packet.bytes = 0;
      }

References packet.

Resize()

void OpusExportProcessor::OggPacket::Resize ( long  size )

inline

Definition at line 258 of file ExportOpus.cpp.

      {
         buffer.resize(size);
         packet.packet = buffer.data();
      }

References buffer, packet, and size.

Referenced by OggPacket(), and Write().

Here is the caller graph for this function:

Write() [1/2]

void OpusExportProcessor::OggPacket::Write ( const void *  data, const long  length  )

inline

Definition at line 279 of file ExportOpus.cpp.

      {
         const auto nextPos = packet.bytes + length;
 
         if (nextPos > buffer.size())
         {
            if (resizable)
               Resize(std::max<size_t>(1024, buffer.size() * 2));
            else
               FailExport(
                  XO("Buffer overflow in OGG packet"), OPUS_BUFFER_TOO_SMALL);
         }
 
         std::copy(
            reinterpret_cast<const byte_type*>(data),
            reinterpret_cast<const byte_type*>(data) + length,
            buffer.data() + packet.bytes);
 
         packet.bytes = nextPos;
      }

References buffer, staffpad::vo::copy(), anonymous_namespace{ExportOpus.cpp}::FailExport(), packet, resizable, Resize(), and XO().

Referenced by Write(), OpusExportProcessor::WriteOpusHeader(), and OpusExportProcessor::WriteTags().

Here is the call graph for this function:

Here is the caller graph for this function:

Write() [2/2]

template<typename IntType >

void OpusExportProcessor::OggPacket::Write ( IntType  value )

inline

Definition at line 301 of file ExportOpus.cpp.

      {
         static_assert(std::is_integral_v<IntType>);
         if constexpr (sizeof (IntType) == 1)
         {
            Write(&value, 1);
         }
         else
         {
            if (IsLittleEndian ())
            {
               Write(&value, sizeof (IntType));
            }
            else
            {
               IntType swapped = SwapIntBytes(value);
               Write(&swapped, sizeof (IntType));
            }
         }
      }

References IsLittleEndian(), SwapIntBytes(), and Write().

Here is the call graph for this function:

Member Data Documentation

buffer

std::vector<byte_type> OpusExportProcessor::OggPacket::buffer

private

Definition at line 335 of file ExportOpus.cpp.

Referenced by GetBuffer(), GetBufferSize(), Resize(), and Write().

packet

ogg_packet OpusExportProcessor::OggPacket::packet {}

Definition at line 332 of file ExportOpus.cpp.

Referenced by MarkBOS(), MarkEOS(), OggPacket(), Reset(), Resize(), Write(), and OpusExportProcessor::WriteOpusHeader().

resizable

bool OpusExportProcessor::OggPacket::resizable { false }

private

Definition at line 336 of file ExportOpus.cpp.

Referenced by Write().

---

The documentation for this struct was generated from the following file:

• ExportOpus.cpp