From 509608be2a1fa432ed75732b159e817f7c5abd3e Mon Sep 17 00:00:00 2001 From: Moritz Bunkus Date: Sun, 16 Feb 2003 12:17:11 +0000 Subject: [PATCH] added doxygen header --- common.cpp | 8 +++++++- common.h | 8 +++++++- error.h | 8 +++++++- mkvmerge.cpp | 8 ++------ p_generic.h | 21 ++++++++++++--------- queue.cpp | 8 +++++++- queue.h | 8 +++++++- r_avi.cpp | 37 ++++++++++++++++--------------------- r_avi.h | 10 +++++++++- r_generic.h | 8 +++++++- 10 files changed, 81 insertions(+), 43 deletions(-) diff --git a/common.cpp b/common.cpp index 4774949ce..56d0d8ce5 100644 --- a/common.cpp +++ b/common.cpp @@ -3,7 +3,6 @@ from component media subtypes common.cpp - helper functions Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: common.cpp,v 1.2 2003/02/16 12:17:10 mosu Exp $ + \brief helper functions, common variables + \author Moritz Bunkus +*/ + #include #include diff --git a/common.h b/common.h index 4270a077e..7f67a0579 100644 --- a/common.h +++ b/common.h @@ -3,7 +3,6 @@ from component media subtypes common.h - helper functions Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: common.h,v 1.3 2003/02/16 12:17:10 mosu Exp $ + \brief definitions used in all programs, helper functions + \author Moritz Bunkus +*/ + #ifndef __COMMON_H__ #define __COMMON_H__ diff --git a/error.h b/error.h index 6313669f5..864166739 100644 --- a/error.h +++ b/error.h @@ -3,7 +3,6 @@ from component media subtypes error.h - class definitions for the error class Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: error.h,v 1.2 2003/02/16 12:17:10 mosu Exp $ + \brief class definitions for the error exception class + \author Moritz Bunkus +*/ + #ifndef __ERROR_H__ #define __ERROR_H__ diff --git a/mkvmerge.cpp b/mkvmerge.cpp index 51a6f7ea2..dbea36995 100644 --- a/mkvmerge.cpp +++ b/mkvmerge.cpp @@ -3,12 +3,8 @@ from component media subtypes mkvmerge.cpp - main program, command line parameter checking, looping, output handling Written by Moritz Bunkus - Based on test6.cpp from the libmatroska, written by Steve Lhomme - for the Matroska project - http://www.matroska.org/ Distributed under the GPL see the file COPYING for details @@ -17,8 +13,8 @@ /*! \file - \version \$Id: mkvmerge.cpp,v 1.3 2003/02/16 11:44:19 mosu Exp $ - \brief create matroska files from other media files, main file + \version \$Id: mkvmerge.cpp,v 1.4 2003/02/16 12:17:10 mosu Exp $ + \brief command line parameter parsing, looping, output handling \author Moritz Bunkus */ diff --git a/p_generic.h b/p_generic.h index ef2383946..8d7c23f12 100644 --- a/p_generic.h +++ b/p_generic.h @@ -3,7 +3,6 @@ from component media subtypes p_generic.h - class definition for the generic packetizer Written by Moritz Bunkus @@ -12,9 +11,18 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: p_generic.h,v 1.2 2003/02/16 12:17:10 mosu Exp $ + \brief class definition for the generic packetizer + \author Moritz Bunkus +*/ + #ifndef __P_GENERIC_H__ #define __P_GENERIC_H__ +#include "common.h" + typedef class generic_packetizer_c { // protected: // int serialno; @@ -22,16 +30,11 @@ typedef class generic_packetizer_c { public: generic_packetizer_c() {}; virtual ~generic_packetizer_c() {}; -// virtual int page_available() = 0; -// virtual stamp_t make_timestamp(ogg_int64_t granulepos) = 0; + virtual int packet_available() = 0; + virtual packet_t *get_packet() = 0; // virtual int serial_in_use(int serial); -// virtual int flush_pages(int header_page = 0) = 0; -// virtual int queue_pages(int header_page = 0) = 0; -// virtual stamp_t get_smallest_timestamp() = 0; -// virtual void produce_eos_packet() = 0; + virtual stamp_t get_smallest_timestamp() = 0; // virtual void produce_header_packets() = 0; -// virtual void reset() = 0; -// virtual void set_comments(vorbis_comment *ncomments); } generic_packetizer_c; #endif // __P_GENERIC_H__ diff --git a/queue.cpp b/queue.cpp index 7b0f06179..ffc68a180 100644 --- a/queue.cpp +++ b/queue.cpp @@ -3,7 +3,6 @@ from component media subtypes queue.cpp - queueing class used by every packetizer Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: queue.cpp,v 1.2 2003/02/16 12:17:10 mosu Exp $ + \brief packet queueing class used by every packetizer + \author Moritz Bunkus +*/ + #include #include #include diff --git a/queue.h b/queue.h index 8467931c3..a762b0ce8 100644 --- a/queue.h +++ b/queue.h @@ -3,7 +3,6 @@ from component media subtypes queue.cpp - class definitions for the queueing class used by every packetizer Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: queue.h,v 1.2 2003/02/16 12:17:11 mosu Exp $ + \brief class definition for the queueing class + \author Moritz Bunkus +*/ + #ifndef __QUEUE_H__ #define __QUEUE_H__ diff --git a/r_avi.cpp b/r_avi.cpp index 284dd5922..e36892adb 100644 --- a/r_avi.cpp +++ b/r_avi.cpp @@ -3,7 +3,6 @@ from component media subtypes r_avi.h - AVI demultiplexer module Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: r_avi.cpp,v 1.3 2003/02/16 12:17:11 mosu Exp $ + \brief AVI demultiplexer module + \author Moritz Bunkus +*/ + #include #include #include @@ -22,8 +28,9 @@ extern "C" { } #include "common.h" +#include "error.h" #include "mkvmerge.h" -//#include "queue.h" +#include "queue.h" #include "r_avi.h" //#include "p_video.h" //#include "p_pcm.h" @@ -508,23 +515,23 @@ ogmmerge_page_t *avi_reader_c::get_header_page(int header_type) { } return NULL; -} +}*/ -ogmmerge_page_t *avi_reader_c::get_page() { +packet_t *avi_reader_c::get_packet() { generic_packetizer_c *winner; avi_demuxer_t *demuxer; winner = NULL; - if ((vpacketizer != NULL) && (vpacketizer->page_available())) + if ((vpacketizer != NULL) && (vpacketizer->packet_available())) winner = vpacketizer; demuxer = ademuxers; while (demuxer != NULL) { if (winner == NULL) { - if (demuxer->packetizer->page_available()) + if (demuxer->packetizer->packet_available()) winner = demuxer->packetizer; - } else if (winner->page_available() && + } else if (winner->packet_available() && (winner->get_smallest_timestamp() > demuxer->packetizer->get_smallest_timestamp())) winner = demuxer->packetizer; @@ -532,10 +539,10 @@ ogmmerge_page_t *avi_reader_c::get_page() { } if (winner != NULL) - return winner->get_page(); + return winner->get_packet(); else return NULL; -}*/ +} int avi_reader_c::display_priority() { // if (vpacketizer != NULL) @@ -544,18 +551,6 @@ int avi_reader_c::display_priority() { // return DISPLAYPRIORITY_LOW; } -/*void avi_reader_c::reset() { - avi_demuxer_t *demuxer; - - if (vpacketizer != NULL) - vpacketizer->reset(); - demuxer = ademuxers; - while (demuxer != NULL) { - demuxer->packetizer->reset(); - demuxer = demuxer->next; - } -}*/ - static char wchar[] = "-\\|/-\\|/-"; void avi_reader_c::display_progress() { diff --git a/r_avi.h b/r_avi.h index beb23efa8..ee6b35278 100644 --- a/r_avi.h +++ b/r_avi.h @@ -3,7 +3,6 @@ from component media subtypes r_avi.h - class definitions for the AVI demultiplexer module Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file r_avi.h + \version \$Id: r_avi.h,v 1.4 2003/02/16 12:17:11 mosu Exp $ + \brief class definitions for the AVI demultiplexer module + \author Moritz Bunkus +*/ + #ifndef __R_AVI_H__ #define __R_AVI_H__ @@ -24,6 +30,7 @@ extern "C" { #include "r_generic.h" #include "p_generic.h" #include "common.h" +#include "error.h" #define RAVI_UNKNOWN 0 #define RAVI_DIVX3 1 @@ -43,6 +50,7 @@ class avi_reader_c: public generic_reader_c { char *chunk; avi_t *avi; // video_packetizer_c *vpacketizer; + generic_packetizer_c *vpacketizer; avi_demuxer_t *ademuxers; double fps; int frames; diff --git a/r_generic.h b/r_generic.h index da7435fb6..bfcc79ba9 100644 --- a/r_generic.h +++ b/r_generic.h @@ -3,7 +3,6 @@ from component media subtypes r_generic.h - class definitions for the generic reader Written by Moritz Bunkus @@ -12,6 +11,13 @@ or visit http://www.gnu.org/copyleft/gpl.html */ +/*! + \file + \version \$Id: r_generic.h,v 1.3 2003/02/16 12:17:11 mosu Exp $ + \brief class definition for the generic reader + \author Moritz Bunkus +*/ + #ifndef __R_GENERIC_H__ #define __R_GENERIC_H__