3.0.0

1. Fix a bug caused by using `MpegClient.terminate()` when a video is closed by the server.
2. Fix dependency issues and cpp standard issues.
3. Add a quick script for fetching the `FFMpeg` dependencies.

Author: cainmagi

MpegCoder/MpegBase.h

@@ -12,31 +12,14 @@
 #define FFMPG4_0
 #define FFMPG4_4
 
-namespace cmpc {
-    extern "C"
-    {
-        #include "libavcodec/avcodec.h"
-        #include "libavformat/avformat.h"
-        #include "libswscale/swscale.h"
-        #include "libavutil/imgutils.h"
-        #include "libavutil/samplefmt.h"
-        #include "libavutil/timestamp.h"
-        #include "libavutil/opt.h"
-        #include "libavutil/avassert.h"
-        #include "libavutil/channel_layout.h"
-        #include "libavutil/mathematics.h"
-        #include "libavutil/time.h"
-        #include "libswresample/swresample.h"
-    }
-}
-
 #define MPEGCODER_CURRENT_VERSION "3.0.0"
 
 #define STREAM_PIX_FMT AVPixelFormat::AV_PIX_FMT_YUV420P /* default pix_fmt */
 
 #define SCALE_FLAGS SWS_BICUBIC
 //SWS_BILINEAR
 
+#include <cstdint>
 #include <iostream>
 //#include <memory>
 #include <string>
@@ -53,6 +36,24 @@ using std::cout;
 using std::endl;
 using std::ostream;
 
+namespace cmpc {
+    extern "C"
+    {
+        #include "libavcodec/avcodec.h"
+        #include "libavformat/avformat.h"
+        #include "libswscale/swscale.h"
+        #include "libavutil/imgutils.h"
+        #include "libavutil/samplefmt.h"
+        #include "libavutil/timestamp.h"
+        #include "libavutil/opt.h"
+        #include "libavutil/avassert.h"
+        #include "libavutil/channel_layout.h"
+        #include "libavutil/mathematics.h"
+        #include "libavutil/time.h"
+        #include "libswresample/swresample.h"
+    }
+}
+
 #ifdef  __cplusplus
 namespace cmpc {
     static const string av_make_error_string2(int errnum) {

MpegCoder/MpegCoder.h

@@ -126,5 +126,8 @@ namespace cmpc {
         int __avcodec_encode_video2_flush(AVCodecContext *enc_ctx, AVPacket *pkt);
         void __copyMetaData(const CMpegEncoder &ref);
     };
+
+    ostream& operator<<(ostream& out, CMpegDecoder& self_class);
+    ostream& operator<<(ostream& out, CMpegEncoder& self_class);
 }
 #endif

MpegCoder/MpegCoder.vcxproj

@@ -181,6 +181,8 @@
     </ClCompile>
   </ItemGroup>
   <ItemGroup>
+    <None Include="..\.gitattributes" />
+    <None Include="..\.gitignore" />
     <None Include="..\LICENSE" />
     <None Include="..\README.md" />
   </ItemGroup>

MpegCoder/MpegCoder.vcxproj.filters

@@ -54,5 +54,7 @@
   <ItemGroup>
     <None Include="..\README.md" />
     <None Include="..\LICENSE" />
+    <None Include="..\.gitignore" />
+    <None Include="..\.gitattributes" />
   </ItemGroup>
 </Project>

MpegCoder/MpegPyd.h

@@ -3,6 +3,7 @@
 
 #define PY_ARRAY_UNIQUE_SYMBOL MPEGARRAY_API
 
+#include <cstdint>
 #include <iostream>
 #include <Python.h>
 #include <numpy/arrayobject.h>
@@ -176,13 +177,17 @@ Yuchen's Mpeg Coder - Readme
 ================================================================================
 V3.0.0 update report:
     1. Fix a severe memory leaking bugs when using AVPacket.
-    2. Support the MpegServer. This class is used for serving the online video
+    2. Fix a bug caused by using `MpegClient.terminate()` when a video is closed
+       by the server.
+    3. Support the MpegServer. This class is used for serving the online video
        streams.
-    3. Refactor the implementation of the loggings.
-    4. Add getParameter() and setParameter(configDict) APIs to MpegEncoder and
+    4. Refactor the implementation of the loggings.
+    5. Add getParameter() and setParameter(configDict) APIs to MpegEncoder and
        MpegServer.
-    5. Move FFMpeg depedencies and the OutputStream class to the cmpc space.
-    6. Upgrade to FFMpeg 4.4 Version.
+    6. Move FFMpeg depedencies and the OutputStream class to the cmpc space.
+    7. Fix dependency issues and cpp standard issues.
+    8. Upgrade to `FFMpeg 4.4` Version.
+    9. Add a quick script for fetching the `FFMpeg` dependencies.
 V2.05 update report:
     1. Fix a severe bug that causes the memory leak when using MpegClient.
     This bug also exists in MpegDecoder, but it seems that the bug would not cause
@@ -1306,7 +1311,7 @@ static PyMethodDef C_MPEC_MethodMembers[] =      // Register the member methods
     { nullptr, nullptr, 0, nullptr }
 };
 
-static PyMethodDef C_MPCT_MethodMembers[] =      //注册类的所有成员函数结构列表.
+static PyMethodDef C_MPCT_MethodMembers[] =      // Register the member methods of Encoder.
 { // This step add the methods to the C-API of the class.
     { "FFmpegSetup",        (PyCFunction)C_MPCT_Setup,             METH_VARARGS | METH_KEYWORDS, \
     "Reset the decoder and the video format.\n - videoAddress: [bytes] the path of decoded video file." },

MpegCoder/MpegStreamer.cpp

@@ -85,6 +85,9 @@ void cmpc::CMpegClient::clear(void) {
         //std::terminate();
         read_handle = std::move(std::thread());
     }
+    else {
+        read_handle = std::move(std::thread());
+    }
     width = height = 0;
     widthDst = heightDst = 0;
     PPixelFormat = AVPixelFormat::AV_PIX_FMT_NONE;
@@ -259,7 +262,9 @@ bool cmpc::CMpegClient::FFmpegSetup() {
         return false;
     }
 
+    read_check.lock();
     reading = true;
+    read_check.unlock();
     return true;
 }
 
@@ -339,18 +344,19 @@ int cmpc::CMpegClient::__save_frame(AVFrame *&frame, AVPacket *&pkt, bool &got_f
     return decoded;
 }
 
-bool cmpc::CMpegClient::__client_holder() {
+void cmpc::CMpegClient::__client_holder() {
     int ret;
     bool got_frame;
     if (frame) {
         cerr << "Current frame is occupied, could not start a new client." << endl;
+        return;
     }
     frame = av_frame_alloc();
     auto pkt = av_packet_alloc();
     if (!frame) {
         cerr << "Could not allocate frame" << endl;
         ret = AVERROR(ENOMEM);
-        return false;
+        return;
     }
     /* initialize packet, set data to NULL, let the demuxer fill it */
     if (PVideoStream && (__dumpControl > 0)) {
@@ -385,14 +391,13 @@ bool cmpc::CMpegClient::__client_holder() {
         /* flush cached frames */
         av_packet_unref(pkt);
         av_packet_unref(temp_pkt);
-        if (read_check.try_lock()) {
-            if (!reading) {
-                read_check.unlock();
-                break;
-            }
-            else {
-                read_check.unlock();
-            }
+        read_check.lock();
+        if (!reading) {
+            read_check.unlock();
+            break;
+        }
+        else {
+            read_check.unlock();
         }
     }
     av_packet_free(&temp_pkt);
@@ -417,7 +422,10 @@ bool cmpc::CMpegClient::__client_holder() {
     if (pkt) {
         av_packet_free(&pkt);
     }
-    return true;
+
+    read_check.lock();
+    reading = false;
+    read_check.unlock();
 }
 
 int cmpc::CMpegClient::__avcodec_decode_video2(AVCodecContext *avctx, AVFrame *frame, bool &got_frame, AVPacket *pkt) {
@@ -520,6 +528,9 @@ PyObject * cmpc::CMpegClient::getParameter(string keyword) {
         return Py_BuildValue("L", _predictFrameNum);
     }
     else if (keyword.compare("srcFrameRate") == 0) {
+        if (!PVideoStream) {
+            return Py_BuildValue("d", 0.0);
+        }
         auto frame_base = PVideoStream->avg_frame_rate;
         double srcFrameRate = static_cast<double>(frame_base.num) / static_cast<double>(frame_base.den);
         return Py_BuildValue("d", srcFrameRate);
@@ -587,14 +598,16 @@ PyObject* cmpc::CMpegClient::getParameter() {
 }
 
 bool cmpc::CMpegClient::start() {
-    if (reading || (frame!=nullptr)) {
+    if (reading && (frame == nullptr)) {
         read_handle = std::move(std::thread(std::mem_fn(&CMpegClient::__client_holder), std::ref(*this)));
         return true;
     }
     return false;
 }
 void cmpc::CMpegClient::terminate() {
-    auto protectReading = true;
+    read_check.lock();
+    auto protectReading = reading;
+    read_check.unlock();
     if (read_handle.joinable()) {
         read_check.lock();
         reading = false;
@@ -603,11 +616,14 @@ void cmpc::CMpegClient::terminate() {
         //std::terminate();
         read_handle = std::move(std::thread());
     }
-    read_check.lock();
-    read_check.unlock();
+    else {
+        read_handle = std::move(std::thread());
+    }
     info_lock.lock();
     info_lock.unlock();
+    read_check.lock();
     reading = protectReading;
+    read_check.unlock();
     if (frame) {
         av_frame_free(&frame);
     }
@@ -1426,9 +1442,9 @@ int cmpc::CMpegServer::__avcodec_encode_video2_flush(AVCodecContext* enc_ctx, AV
 
 int cmpc::CMpegServer::ServeFrameBlock(PyArrayObject* PyFrame) {
     if (__start_time > 0) {
-        auto cur_time = av_gettime() - __start_time;
+        auto cur_time = static_cast<int64_t>(av_gettime() - __start_time);
         if (cur_time < __cur_time) {
-            av_usleep((__cur_time - cur_time) / 2);
+            av_usleep(static_cast<unsigned int>((__cur_time - cur_time) / 2));
         }
         ServeFrame(PyFrame);
     }

MpegCoder/MpegStreamer.h

@@ -104,7 +104,7 @@ namespace cmpc {
         int refcount;                       // Reference count of the video frame.
         bool __setup_check() const;
         int _open_codec_context(int &stream_idx, AVCodecContext *&dec_ctx, AVFormatContext *PFormatCtx, enum AVMediaType type);
-        bool __client_holder();
+        void __client_holder();
         AVRational _setAVRational(int num, int den);
         int __save_frame(AVFrame *&frame, AVPacket *&pkt, bool &got_frame, int cached);
         int __avcodec_decode_video2(AVCodecContext *avctx, AVFrame *frame, bool &got_frame, AVPacket *pkt);
@@ -167,5 +167,8 @@ namespace cmpc {
         int __avcodec_encode_video2_flush(AVCodecContext* enc_ctx, AVPacket* pkt);
         void __copyMetaData(const CMpegServer& ref);
     };
+
+    ostream& operator<<(ostream& out, CMpegClient& self_class);
+    ostream& operator<<(ostream& out, CMpegServer& self_class);
 }
 #endif

README.md

@@ -23,7 +23,13 @@ The following instructions are used for building the project on Windows with Vis
     git clone --single-branch -b master https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python.git
     ```
 
-2. Download the FFMpeg dependencies, including `include` and `lib`.
+2. Download the FFMpeg dependencies, including `include` and `lib`. Users could download dependencies manually by checking [the release page :link:](https://github.com/cainmagi/FFmpeg-Encoder-Decoder-for-Python/releases/tag/deps-3.0.0). However, we recommend users to use the following script to get the dependencies quickly:
+
+    ```bash
+    python webtools.py
+    ```
+
+    This script requires users to install `urllib3`. The `tqdm` is also recommended to be installed.
 
 3. The following configurations should be set for `All` (both debug and release) and `x64`. Open the project by `MpegCoder.sln`. Then configure the following paths of the include directories and the library directories. In both configurations, the first item is required to be modified according to your python path, the second item is required to be modified according to your numpy path.
     |  Path  |  Screenshot  |
@@ -51,15 +57,21 @@ The following instructions are used for building the project on Windows with Vis
 
 1. Fix a severe memory leaking bugs when using `AVPacket`.
 
-2. Support the `MpegServer`. This class is used for serving the online video streams.
+2. Fix a bug caused by using `MpegClient.terminate()` when a video is closed by the server.
+
+3. Support the `MpegServer`. This class is used for serving the online video streams.
+
+4. Refactor the implementation of the loggings.
+
+5. Add `getParameter()` and `setParameter(configDict)` APIs to `MpegEncoder` and `MpegServer`.
 
-3. Refactor the implementation of the loggings.
+6. Move `FFMpeg` depedencies and the `OutputStream` class to the `cmpc` space.
 
-4. Add `getParameter()` and `setParameter(configDict)` APIs to `MpegEncoder` and `MpegServer`.
+7. Fix dependency issues and cpp standard issues.
 
-5. Move `FFMpeg` depedencies and the `OutputStream` class to the `cmpc` space.
+8. Upgrade to `FFMpeg 4.4` Version.
 
-6. Upgrade to `FFMpeg 4.4` Version.
+9. Add a quick script for fetching the `FFMpeg` dependencies.
 
 ### V2.05 update report: