Added extra doxygen, refactored all analysers into a separate namespace.

src/analysers/amf_analyser.cpp

@@ -9,18 +9,32 @@
 #include <mist/amf.h>
 #include <mist/config.h>
 
-/// Debugging tool for AMF data.
+///\brief Holds everything unique to the analysers.
+namespace Analysers {
+  ///\brief Debugging tool for AMF data.
+  ///
   /// Expects AMF data through stdin, outputs human-readable information to stderr.
+  ///\return The return code of the analyser.
+  int analyseAMF(){
+    std::string amfBuffer;
+    //Read all of std::cin to amfBuffer
+    while (std::cin.good()){
+      amfBuffer += std::cin.get();
+    }
+    //Strip the invalid last character
+    amfBuffer.erase((amfBuffer.end() - 1));
+    //Parse into an AMF::Object
+    AMF::Object amfData = AMF::parse(amfBuffer);
+    //Print the output.
+    std::cerr << amfData.Print() << std::endl;
+    return 0;
+  }
+}
+
 int main(int argc, char ** argv){
   Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
   conf.parseArgs(argc, argv);
-  std::string temp;
+  
-  while (std::cin.good()){
+  return Analysers::analyseAMF();
-    temp += std::cin.get();
-  } //read all of std::cin to temp
-  temp.erase(temp.size() - 1, 1); //strip the invalid last character
-  AMF::Object amfdata = AMF::parse(temp); //parse temp into an AMF::Object
-  std::cerr << amfdata.Print() << std::endl; //pretty-print the object
-  return 0;
 }
 

src/analysers/dtsc_analyser.cpp

@@ -3,15 +3,19 @@
 
 #include <string>
 #include <iostream>
+
 #include <mist/dtsc.h>
 #include <mist/json.h>
 #include <mist/config.h>
 
-/// Reads an DTSC file and prints all readable data about it
+///\brief Holds everything unique to the analysers.  
-int main(int argc, char ** argv){
+namespace Analysers {
-  Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
+  ///\brief Debugging tool for DTSC data.
-  conf.addOption("filename", JSON::fromString("{\"arg_num\":1, \"arg\":\"string\", \"help\":\"Filename of the DTSC file to analyse.\"}"));
+  ///
-  conf.parseArgs(argc, argv);
+  /// Expects DTSC data in a file given on the command line, outputs human-readable information to stderr.
+  ///\param conf The configuration parsed from the commandline.
+  ///\return The return code of the analyser.
+  int analyseDTSC(Util::Config conf){
     DTSC::File F(conf.getString("filename"));
     JSON::Value meta = F.getMeta();
     std::cout << meta.toPrettyString() << std::endl;
@@ -114,4 +118,13 @@ int main(int argc, char ** argv){
       std::cout << "    B-frames: " << bfrm_min << " - " << bfrm_max << std::endl;
     }
     return 0;
+  }
+}
+
+/// Reads an DTSC file and prints all readable data about it
+int main(int argc, char ** argv){
+  Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
+  conf.addOption("filename", JSON::fromString("{\"arg_num\":1, \"arg\":\"string\", \"help\":\"Filename of the DTSC file to analyse.\"}"));
+  conf.parseArgs(argc, argv);
+  return Analysers::analyseDTSC(conf);
 } //main

src/analysers/flv_analyser.cpp

@@ -14,15 +14,25 @@
 #include <mist/flv_tag.h> //FLV support
 #include <mist/config.h>
 
-/// Reads FLV from stdin and outputs human-readable information to stderr.
+///\brief Holds everything unique to the analysers.
-int main(int argc, char ** argv){
+namespace Analysers {
-  Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
+  ///\brief Debugging tool for FLV data.
-  conf.parseArgs(argc, argv);
+  ///
-  FLV::Tag FLV_in; // Temporary storage for incoming FLV data.
+  /// Expects FLV data through stdin, outputs human-readable information to stderr.
+  ///\return The return code of the analyser.
+  int analyseFLV(){
+    FLV::Tag flvData; // Temporary storage for incoming FLV data.
     while ( !feof(stdin)){
-    if (FLV_in.FileLoader(stdin)){
+      if (flvData.FileLoader(stdin)){
-      std::cout << "Tag: " << FLV_in.tagType() << "\n\tTime: " << FLV_in.tagTime() << std::endl;
+        std::cout << "Tag: " << flvData.tagType() << "\n\tTime: " << flvData.tagTime() << std::endl;
       }
     }
     return 0;
   }
+}
+
+int main(int argc, char ** argv){
+  Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
+  conf.parseArgs(argc, argv);
+  return Analysers::analyseFLV();
+}

src/analysers/mp4_analyser.cpp

@@ -10,22 +10,33 @@
 #include <mist/mp4.h>
 #include <mist/config.h>
 
+///\brief Holds everything unique to the analysers.
+namespace Analysers {
+  ///\brief Debugging tool for MP4 data.
+  ///
+  /// Expects MP4 data through stdin, outputs human-readable information to stderr.
+  ///\return The return code of the analyser.
+  int analyseMP4(){
+    std::string mp4Buffer;
+    //Read all of std::cin to mp4Buffer
+    while (std::cin.good()){
+      mp4Buffer += std::cin.get();
+    }
+    mp4Buffer.erase(mp4Buffer.size() - 1, 1);
+
+    MP4::Box mp4Data;
+    while (mp4Data.read(mp4Buffer)){
+      std::cerr << mp4Data.toPrettyString(0) << std::endl;
+    }
+    return 0;
+  }
+}
+
 /// Debugging tool for MP4 data.
 /// Expects MP4 data through stdin, outputs human-readable information to stderr.
 int main(int argc, char ** argv){
   Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
   conf.parseArgs(argc, argv);
-
+  return Analysers::analyseMP4();
-  std::string temp;
-  while (std::cin.good()){
-    temp += std::cin.get();
-  } //read all of std::cin to temp
-  temp.erase(temp.size() - 1, 1); //strip the invalid last character
-
-  MP4::Box mp4data;
-  while (mp4data.read(temp)){
-    std::cerr << mp4data.toPrettyString(0) << std::endl;
-  }
-  return 0;
 }
 

src/analysers/rtmp_analyser.cpp

@@ -1,51 +1,43 @@
 /// \file rtmp_analyser.cpp
 /// Debugging tool for RTMP data.
-/// Expects RTMP data of one side of the conversion through stdin, outputs human-readable information to stderr.
-/// Automatically skips 3073 bytes of handshake data.
-/// Optionally reconstructs an FLV file
-/// Singular argument is a bitmask indicating the following (defaulting to 0):
-/// - 0  = Info: Output chunk meanings and fulltext commands to stderr.
-/// - 1  = Reconstruct: Output valid .flv file to stdout.
-/// - 2  = Explicit: Audio/video data details.
-/// - 4  = Verbose: details about every whole chunk.
-
-#include <cstdlib>
 #include <iostream>
 #include <fstream>
 #include <string>
-#include <iostream>
+
+#include <cstdlib>
+
 #include <mist/flv_tag.h>
 #include <mist/amf.h>
 #include <mist/rtmpchunks.h>
 #include <mist/config.h>
 
-int Detail = 0;
 #define DETAIL_RECONSTRUCT 1
 #define DETAIL_EXPLICIT 2
 #define DETAIL_VERBOSE 4
 
-/// Debugging tool for RTMP data.
+///\brief Holds everything unique to the analysers.
-/// Expects RTMP data of one side of the conversion through stdin, outputs human-readable information to stderr.
+namespace Analysers {
-/// Will output FLV file to stdout, if available
+  ///\brief Debugging tool for RTMP data.
-/// Automatically skips 3073 bytes of handshake data.
+  ///
-int main(int argc, char ** argv){
+  ///Expects RTMP data of one side of the conversation through stdin, outputs human-readable information to stderr.
-  Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
+  ///
-  conf.addOption("detail",
+  ///Will output FLV file to stdout, if available.
-      JSON::fromString(
+  ///
-          "{\"arg_num\":1, \"arg\":\"integer\", \"default\":0, \"help\":\"Bitmask, 1 = Reconstruct, 2 = Explicit media info, 4 = Verbose chunks\"}"));
+  ///Automatically skips the handshake data.
-  conf.parseArgs(argc, argv);
+  ///\param conf The configuration parsed from the commandline.
-
+  ///\return The return code of the analyser.
-  Detail = conf.getInteger("detail");
+  int analyseRTMP(Util::Config conf){
+    int Detail = conf.getInteger("detail");
     if (Detail > 0){
       fprintf(stderr, "Detail level set:\n");
-    if ((Detail & DETAIL_RECONSTRUCT) == DETAIL_RECONSTRUCT){
+      if (Detail & DETAIL_RECONSTRUCT){
         fprintf(stderr, " - Will reconstuct FLV file to stdout\n");
         std::cout.write(FLV::Header, 13);
       }
-    if ((Detail & DETAIL_EXPLICIT) == DETAIL_EXPLICIT){
+      if (Detail & DETAIL_EXPLICIT){
         fprintf(stderr, " - Will list explicit video/audio data information\n");
       }
-    if ((Detail & DETAIL_VERBOSE) == DETAIL_VERBOSE){
+      if (Detail & DETAIL_VERBOSE){
         fprintf(stderr, " - Will list verbose chunk information\n");
       }
     }
@@ -61,7 +53,7 @@ int main(int argc, char ** argv){
     AMF::Object3 amf3data("empty", AMF::AMF3_DDV_CONTAINER);
 
     while (next.Parse(inbuffer)){
-    if ((Detail & DETAIL_VERBOSE) == DETAIL_VERBOSE){
+      if (Detail & DETAIL_VERBOSE){
         fprintf(stderr, "Chunk info: [%#2X] CS ID %u, timestamp %u, len %u, type ID %u, Stream ID %u\n", next.headertype, next.cs_id, next.timestamp,
             next.len, next.msg_type_id, next.msg_stream_id);
       }
@@ -125,11 +117,11 @@ int main(int argc, char ** argv){
         case 8:
           if (Detail & (DETAIL_EXPLICIT | DETAIL_RECONSTRUCT)){
             F.ChunkLoader(next);
-          if ((Detail & DETAIL_EXPLICIT) == DETAIL_EXPLICIT){
+            if (Detail & DETAIL_EXPLICIT){
               fprintf(stderr, "Received %i bytes audio data\n", next.len);
               std::cerr << "Got a " << F.len << " bytes " << F.tagType() << " FLV tag of time " << F.tagTime() << "." << std::endl;
             }
-          if ((Detail & DETAIL_RECONSTRUCT) == DETAIL_RECONSTRUCT){
+            if (Detail & DETAIL_RECONSTRUCT){
               std::cout.write(F.data, F.len);
             }
           }
@@ -137,11 +129,11 @@ int main(int argc, char ** argv){
         case 9:
           if (Detail & (DETAIL_EXPLICIT | DETAIL_RECONSTRUCT)){
             F.ChunkLoader(next);
-          if ((Detail & DETAIL_EXPLICIT) == DETAIL_EXPLICIT){
+            if (Detail & DETAIL_EXPLICIT){
               fprintf(stderr, "Received %i bytes video data\n", next.len);
               std::cerr << "Got a " << F.len << " bytes " << F.tagType() << " FLV tag of time " << F.tagTime() << "." << std::endl;
             }
-          if ((Detail & DETAIL_RECONSTRUCT) == DETAIL_RECONSTRUCT){
+            if (Detail & DETAIL_RECONSTRUCT){
               std::cout.write(F.data, F.len);
             }
           }
@@ -169,7 +161,7 @@ int main(int argc, char ** argv){
           fprintf(stderr, "Received AFM0 data message (metadata):\n");
           amfdata = AMF::parse(next.data);
           amfdata.Print();
-        if ((Detail & DETAIL_RECONSTRUCT) == DETAIL_RECONSTRUCT){
+          if (Detail & DETAIL_RECONSTRUCT){
             F.ChunkLoader(next);
             std::cout.write(F.data, F.len);
           }
@@ -195,4 +187,15 @@ int main(int argc, char ** argv){
     } //while chunk parsed
     fprintf(stderr, "No more readable data\n");
     return 0;
+  }
+}
+
+int main(int argc, char ** argv){
+  Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
+  conf.addOption("detail",
+      JSON::fromString(
+          "{\"arg_num\":1, \"arg\":\"integer\", \"default\":0, \"help\":\"Bitmask, 1 = Reconstruct, 2 = Explicit media info, 4 = Verbose chunks\"}"));
+  conf.parseArgs(argc, argv);
+
+  return Analysers::analyseRTMP(conf);
 } //main

src/buffer/buffer.cpp

@@ -23,13 +23,16 @@ namespace Buffer {
   Stream * thisStream = 0;
   Socket::Server SS; ///< The server socket.
 
-  /// Gets the current system time in milliseconds.
+  ///\brief Gets the current system time in milliseconds.
+  ///\return The current timestamp in milliseconds.
   long long int getNowMS(){
     timeval t;
     gettimeofday( &t, 0);
     return t.tv_sec * 1000 + t.tv_usec / 1000;
   } //getNowMS
 
+  ///\brief A function running in a thread to send all statistics.
+  ///\param empty A null pointer.
   void handleStats(void * empty){
     if (empty != 0){
       return;
@@ -51,6 +54,8 @@ namespace Buffer {
     StatsSocket.close();
   }
 
+  ///\brief A function running in a thread to handle a new user connection.
+  ///\param v_usr The user that is connected.
   void handleUser(void * v_usr){
     user * usr = (user*)v_usr;
 #if DEBUG >= 5
@@ -153,7 +158,10 @@ namespace Buffer {
     usr->Disconnect("Socket closed.");
   }
 
-  /// Loop reading DTSC data from stdin and processing it at the correct speed.
+  ///\brief A function running a thread to handle input data through stdin.
+  ///
+  ///Automatically slows down to realtime playback.
+  ///\param empty A null pointer.
   void handleStdin(void * empty){
     if (empty != 0){
       return;
@@ -190,8 +198,8 @@ namespace Buffer {
     buffer_running = false;
   }
 
-  /// Loop reading DTSC data from an IP push address.
+  ///\brief A function running a thread to handle input data through rtmp push.
-  /// No changes to the speed are made.
+  ///\param empty A null pointer.
   void handlePushin(void * empty){
     if (empty != 0){
       return;
@@ -221,7 +229,10 @@ namespace Buffer {
     }
   }
 
-  /// Starts a loop, waiting for connections to send data to.
+  ///\brief Starts a loop, waiting for connections to send data to.
+  ///\param argc The number of arguments to the program.
+  ///\param argv The arguments to the program.
+  ///\return The return code of the buffer.
   int Start(int argc, char ** argv){
     Util::Config conf = Util::Config(argv[0], PACKAGE_VERSION);
     conf.addOption("stream_name",
@@ -295,7 +306,7 @@ namespace Buffer {
 ;
 //Buffer namespace
 
-/// Entry point for Buffer, simply calls Buffer::Start().
+///\brief Entry point for Buffer, simply calls Buffer::Start().
 int main(int argc, char ** argv){
   return Buffer::Start(argc, argv);
 } //main

src/buffer/buffer_user.h

@@ -11,17 +11,19 @@ namespace Buffer {
   /// Converts a stats line to up, down, host, connector and conntime values.
   class Stats{
     public:
-      unsigned int up;
+      unsigned int up;///<The amount of bytes sent upstream.
-      unsigned int down;
+      unsigned int down;///<The amount of bytes received downstream.
-      std::string host;
+      std::string host;///<The connected host.
-      std::string connector;
+      std::string connector;///<The connector the user is connected with.
-      unsigned int conntime;
+      unsigned int conntime;///<The amount of time the user is connected.
       Stats();
       Stats(std::string s);
   };
 
-  /// Holds connected users.
+  ///\brief Keeps track of connected users.
-  /// Keeps track of what buffer users are using and the connection status.
+  ///
+  ///Keeps track of which buffer the user currently uses,
+  ///and its connection status.
   class user{
     public:
       tthread::thread * Thread; ///< Holds the thread dealing with this user.

src/buffer/player.cpp

@@ -24,21 +24,27 @@
 #define CYG_LOOP 
 #endif
 
-/// Copy of stats from buffer_user.cpp
+///Converts a stats line to up, down, host, connector and conntime values.
 class Stats{
   public:
-    unsigned int up;
+    unsigned int up;///<The amount of bytes sent upstream.
-    unsigned int down;
+    unsigned int down;///<The amount of bytes received downstream.
-    std::string host;
+    std::string host;///<The connected host.
-    std::string connector;
+    std::string connector;///<The connector the user is connected with.
-    unsigned int conntime;
+    unsigned int conntime;///<The amount of time the user is connected.
+    ///\brief Default stats constructor.
+    ///
+    ///Should not be used.
     Stats(){
       up = 0;
       down = 0;
       conntime = 0;
     }
     ;
+    ///\brief Stats constructor reading a string.
+    ///
     ///Reads a stats string and parses it to the internal representation.
+    ///\param s The string of stats.
     Stats(std::string s){
       size_t f = s.find(' ');
       if (f != std::string::npos){

src/controller/controller_streams.cpp

@@ -10,6 +10,10 @@ namespace Controller {
 
   std::map<std::string, int> lastBuffer; ///< Last moment of contact with all buffers.
   
+  ///\brief Checks whether two streams are equal.
+  ///\param one The first stream for the comparison.
+  ///\param two The second stream for the comparison.
+  ///\return True if the streams are equal, false otherwise.
   bool streamsEqual(JSON::Value & one, JSON::Value & two){
     if ( !one.isMember("source") || !two.isMember("source") || one["source"] != two["source"]){
       return false;
@@ -17,6 +21,9 @@ namespace Controller {
     return true;
   }
 
+  ///\brief Starts a single stream
+  ///\param name The name of the stream
+  ///\param data The corresponding configuration values.
   void startStream(std::string name, JSON::Value & data){
     data["online"] = (std::string)"Checking...";
     data.removeMember("error");
@@ -76,6 +83,8 @@ namespace Controller {
     }
   }
 
+  ///\brief Checks all streams, restoring if needed.
+  ///\param data The stream configuration for the server.
   void CheckAllStreams(JSON::Value & data){
     long long int currTime = Util::epoch();
     for (JSON::ObjIter jit = data.ObjBegin(); jit != data.ObjEnd(); jit++){
@@ -131,6 +140,9 @@ namespace Controller {
     }
   }
 
+  ///\brief Parse a given stream configuration.
+  ///\param in The requested configuration.
+  ///\param out The new configuration after parsing.
   void CheckStreams(JSON::Value & in, JSON::Value & out){
     bool changed = false;