From 2583e527f161118f023dd1e9e8b591578e0430f2 Mon Sep 17 00:00:00 2001
From: Edouard DUPIN <yui.heero@gmail.com>
Date: Tue, 10 Feb 2015 21:35:34 +0100
Subject: [PATCH] [DEV] add basic doc and licence

---
 README.md        | 33 +++++++++++++++++++++++++++++++++
 audio/channel.h  |  4 ++--
 audio/format.cpp |  3 +++
 audio/format.h   | 15 +++++++++------
 license.txt      | 13 +++++++++++++
 monk_audio.py    | 18 ++++++++++++++++++
 6 files changed, 78 insertions(+), 8 deletions(-)
 create mode 100644 README.md
 create mode 100644 license.txt
 create mode 100644 monk_audio.py

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e20a30a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+audio
+=====
+
+`audio` is simple audio basic format description
+
+Instructions
+============
+
+To compile:
+
+	lutin.py audio
+
+note:
+
+	depend on etk library (apache 2)
+
+
+License (APACHE v2.0)
+=====================
+Copyright audio Edouard DUPIN
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
diff --git a/audio/channel.h b/audio/channel.h
index cd1be4f..0c7074b 100644
--- a/audio/channel.h
+++ b/audio/channel.h
@@ -4,8 +4,8 @@
  * @license APACHE v2.0 (see license file)
  */
 
-#ifndef __AUDIO_CORE_CHANNEL_H__
-#define __AUDIO_CORE_CHANNEL_H__
+#ifndef __AUDIO_CHANNEL_H__
+#define __AUDIO_CHANNEL_H__
 
 #include <string>
 #include <vector>
diff --git a/audio/format.cpp b/audio/format.cpp
index e6938c5..edbb2b1 100644
--- a/audio/format.cpp
+++ b/audio/format.cpp
@@ -10,10 +10,13 @@
 static const char* listValues[] = {
 	"unknow",
 	"int8",
+	"int8_on_int16",
 	"int16",
 	"int16_on_int32",
 	"int24",
 	"int32",
+	"int32_on_int64",
+	"int64",
 	"float",
 	"double"
 };
diff --git a/audio/format.h b/audio/format.h
index 4f6f430..d1c4e6e 100644
--- a/audio/format.h
+++ b/audio/format.h
@@ -4,8 +4,8 @@
  * @license APACHE v2.0 (see license file)
  */
 
-#ifndef __AUDIO_CORE_FORMAT_H__
-#define __AUDIO_CORE_FORMAT_H__
+#ifndef __AUDIO_FORMAT_H__
+#define __AUDIO_FORMAT_H__
 
 #include <string>
 
@@ -13,12 +13,15 @@ namespace audio {
 	enum format {
 		format_unknow,
 		format_int8, //!< Signed 8 bits
+		format_int8_on_int16, //!< Signed 8 bits on 16 bits data (8 bit fixpoint value)
 		format_int16, //!< Signed 16 bits
-		format_int16_on_int32, //!< Signed 16 bits on 32bits data (16 bit fixpoint value)
-		format_int24, //!< Signed 24 bits
+		format_int16_on_int32, //!< Signed 16 bits on 32 bits data (16 bit fixpoint value)
+		format_int24, //!< Signed 24 bits on 32 bits (lower)
 		format_int32, //!< Signed 32 bits
-		format_float, //!< Floating point (single precision)
-		format_double //!< Floating point (double precision)
+		format_int32_on_int64, //!< Signed 32 bits on 64 bits data (32 bit fixpoint value)
+		format_int64, //!< Signed 64 bits
+		format_float, //!< Floating point 32 bits (single precision)
+		format_double //!< Floating point 64 bits (double precision)
 	};
 	std::string getFormatString(enum audio::format _format);
 	enum audio::format getFormatFromString(const std::string& _value);
diff --git a/license.txt b/license.txt
new file mode 100644
index 0000000..a95300f
--- /dev/null
+++ b/license.txt
@@ -0,0 +1,13 @@
+Copyright audio Edouard DUPIN
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
\ No newline at end of file
diff --git a/monk_audio.py b/monk_audio.py
new file mode 100644
index 0000000..e0d8f29
--- /dev/null
+++ b/monk_audio.py
@@ -0,0 +1,18 @@
+#!/usr/bin/python
+import monkModule as module
+import monkTools as tools
+
+def get_desc():
+	return "audio : Audio basic foramt description"
+
+
+def create():
+	myModule = module.Module(__file__, 'audio', 'LIBRARY')
+	# set documentation properties:
+	myModule.set_website("http://heeroyui.github.io/audio/")
+	myModule.set_website_sources("http://github.com/heeroyui/audio/")
+	myModule.set_path(tools.get_current_path(__file__) + "/audio/")
+	myModule.set_path_general_doc(tools.get_current_path(__file__) + "/doc/")
+	# return the created description:
+	return myModule
+