Skip to content

Commit

Permalink
Added doxygen documentation to Vorbis Encoder
Browse files Browse the repository at this point in the history
  • Loading branch information
runei committed Aug 4, 2024
1 parent 0138d90 commit dbc9075
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions src/internal_modules/roc_audio/vorbis_encoder.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,28 @@
namespace roc {
namespace audio {

//! Vorbis Encoder.
class VorbisEncoder : public IFrameEncoder {
public:
//! Initialize.
VorbisEncoder(const SampleSpec& sample_spec);

//! End.
~VorbisEncoder();

//! Check if the object was successfully constructed.
virtual status::StatusCode init_status() const;

virtual size_t encoded_byte_count(size_t n_samples) const;
//! Get encoded frame size in bytes for given number of samples per channel.
virtual size_t encoded_byte_count(size_t num_samples) const;

virtual void begin_frame(void* frame_data, size_t frame_size);
//! Start encoding a new frame.
virtual void begin_frame(void* frame, size_t frame_size);

//! Encode samples.
virtual size_t write_samples(const sample_t* samples, size_t n_samples);

//! Finish encoding frame.
virtual void end_frame();

private:
Expand Down

0 comments on commit dbc9075

Please sign in to comment.