Document missing package to build for Windows

To build ffmpeg, libz is necessary.

Refs #4955 <https://github.com/Genymobile/scrcpy/issues/4955>

app/deps/libusb.sh

@@ -5,9 +5,9 @@ cd "$DEPS_DIR"
 . common
 
 VERSION=1.0.27
-FILENAME=libusb-$VERSION.tar.gz
+FILENAME=libusb-$VERSION.tar.bz2
 PROJECT_DIR=libusb-$VERSION
-SHA256SUM=e8f18a7a36ecbb11fb820bd71540350d8f61bcd9db0d2e8c18a6fb80b214a3de
+SHA256SUM=ffaa41d741a8a3bee244ac8e54a72ea05bf2879663c098c82fc5757853441575
 
 cd "$SOURCES_DIR"
 
@@ -15,7 +15,7 @@ if [[ -d "$PROJECT_DIR" ]]
 then
     echo "$PWD/$PROJECT_DIR" found
 else
-    get_file "https://github.com/libusb/libusb/archive/refs/tags/v$VERSION.tar.gz" "$FILENAME" "$SHA256SUM"
+    get_file "https://github.com/libusb/libusb/releases/download/v$VERSION/libusb-$VERSION.tar.bz2" "$FILENAME" "$SHA256SUM"
     tar xf "$FILENAME"  # First level directory is "$PROJECT_DIR"
 fi
 
@@ -33,7 +33,6 @@ else
     mkdir "$HOST"
     cd "$HOST"
 
-    "$SOURCES_DIR/$PROJECT_DIR"/bootstrap.sh
     "$SOURCES_DIR/$PROJECT_DIR"/configure \
         --prefix="$INSTALL_DIR/$HOST" \
         --host="$HOST_TRIPLET" \

app/scrcpy.1

@@ -577,14 +577,6 @@ Flip display horizontally
 .B MOD+Shift+Up, MOD+Shift+Down
 Flip display vertically
 
-.TP
-.B MOD+z
-Pause or re-pause display
-
-.TP
-.B MOD+Shift+z
-Unpause display
-
 .TP
 .B MOD+g
 Resize window to 1:1 (pixel\-perfect)

app/src/cli.c

@@ -900,14 +900,6 @@ static const struct sc_shortcut shortcuts[] = {
         .shortcuts = { "MOD+Shift+Up", "MOD+Shift+Down" },
         .text = "Flip display vertically",
     },
-    {
-        .shortcuts = { "MOD+z" },
-        .text = "Pause or re-pause display",
-    },
-    {
-        .shortcuts = { "MOD+Shift+z" },
-        .text = "Unpause display",
-    },
     {
         .shortcuts = { "MOD+g" },
         .text = "Resize window to 1:1 (pixel-perfect)",

app/src/input_manager.c

@@ -402,7 +402,6 @@ sc_input_manager_process_key(struct sc_input_manager *im,
                              const SDL_KeyboardEvent *event) {
     // controller is NULL if --no-control is requested
     bool control = im->controller;
-    bool paused = im->screen->paused;
 
     SDL_Keycode keycode = event->keysym.sym;
     uint16_t mod = event->keysym.mod;
@@ -428,51 +427,46 @@ sc_input_manager_process_key(struct sc_input_manager *im,
         enum sc_action action = down ? SC_ACTION_DOWN : SC_ACTION_UP;
         switch (keycode) {
             case SDLK_h:
-                if (im->kp && !shift && !repeat && !paused) {
+                if (im->kp && !shift && !repeat) {
                     action_home(im, action);
                 }
                 return;
             case SDLK_b: // fall-through
             case SDLK_BACKSPACE:
-                if (im->kp && !shift && !repeat && !paused) {
+                if (im->kp && !shift && !repeat) {
                     action_back(im, action);
                 }
                 return;
             case SDLK_s:
-                if (im->kp && !shift && !repeat && !paused) {
+                if (im->kp && !shift && !repeat) {
                     action_app_switch(im, action);
                 }
                 return;
             case SDLK_m:
-                if (im->kp && !shift && !repeat && !paused) {
+                if (im->kp && !shift && !repeat) {
                     action_menu(im, action);
                 }
                 return;
             case SDLK_p:
-                if (im->kp && !shift && !repeat && !paused) {
+                if (im->kp && !shift && !repeat) {
                     action_power(im, action);
                 }
                 return;
             case SDLK_o:
-                if (control && !repeat && down && !paused) {
+                if (control && !repeat && down) {
                     enum sc_screen_power_mode mode = shift
                                                    ? SC_SCREEN_POWER_MODE_NORMAL
                                                    : SC_SCREEN_POWER_MODE_OFF;
                     set_screen_power_mode(im, mode);
                 }
                 return;
-            case SDLK_z:
-                if (down && !repeat) {
-                    sc_screen_set_paused(im->screen, !shift);
-                }
-                return;
             case SDLK_DOWN:
                 if (shift) {
                     if (!repeat & down) {
                         apply_orientation_transform(im,
                                                     SC_ORIENTATION_FLIP_180);
                     }
-                } else if (im->kp && !paused) {
+                } else if (im->kp) {
                     // forward repeated events
                     action_volume_down(im, action);
                 }
@@ -483,7 +477,7 @@ sc_input_manager_process_key(struct sc_input_manager *im,
                         apply_orientation_transform(im,
                                                     SC_ORIENTATION_FLIP_180);
                     }
-                } else if (im->kp && !paused) {
+                } else if (im->kp) {
                     // forward repeated events
                     action_volume_up(im, action);
                 }
@@ -511,17 +505,17 @@ sc_input_manager_process_key(struct sc_input_manager *im,
                 }
                 return;
             case SDLK_c:
-                if (im->kp && !shift && !repeat && down && !paused) {
+                if (im->kp && !shift && !repeat && down) {
                     get_device_clipboard(im, SC_COPY_KEY_COPY);
                 }
                 return;
             case SDLK_x:
-                if (im->kp && !shift && !repeat && down && !paused) {
+                if (im->kp && !shift && !repeat && down) {
                     get_device_clipboard(im, SC_COPY_KEY_CUT);
                 }
                 return;
             case SDLK_v:
-                if (im->kp && !repeat && down && !paused) {
+                if (im->kp && !repeat && down) {
                     if (shift || im->legacy_paste) {
                         // inject the text as input events
                         clipboard_paste(im);
@@ -553,7 +547,7 @@ sc_input_manager_process_key(struct sc_input_manager *im,
                 }
                 return;
             case SDLK_n:
-                if (control && !repeat && down && !paused) {
+                if (control && !repeat && down) {
                     if (shift) {
                         collapse_panels(im);
                     } else if (im->key_repeat == 0) {
@@ -564,12 +558,12 @@ sc_input_manager_process_key(struct sc_input_manager *im,
                 }
                 return;
             case SDLK_r:
-                if (control && !shift && !repeat && down && !paused) {
+                if (control && !shift && !repeat && down) {
                     rotate_device(im);
                 }
                 return;
             case SDLK_k:
-                if (control && !shift && !repeat && down && !paused
+                if (control && !shift && !repeat && down
                         && im->kp && im->kp->hid) {
                     // Only if the current keyboard is hid
                     open_hard_keyboard_settings(im);
@@ -580,7 +574,7 @@ sc_input_manager_process_key(struct sc_input_manager *im,
         return;
     }
 
-    if (!im->kp || paused) {
+    if (!im->kp) {
         return;
     }
 
@@ -628,6 +622,7 @@ sc_input_manager_process_key(struct sc_input_manager *im,
 static void
 sc_input_manager_process_mouse_motion(struct sc_input_manager *im,
                                       const SDL_MouseMotionEvent *event) {
+
     if (event->which == SDL_TOUCH_MOUSEID) {
         // simulated from touch events, so it's a duplicate
         return;
@@ -700,16 +695,16 @@ sc_input_manager_process_touch(struct sc_input_manager *im,
 static void
 sc_input_manager_process_mouse_button(struct sc_input_manager *im,
                                       const SDL_MouseButtonEvent *event) {
+    bool control = im->controller;
+
     if (event->which == SDL_TOUCH_MOUSEID) {
         // simulated from touch events, so it's a duplicate
         return;
     }
 
-    bool control = im->controller;
-    bool paused = im->screen->paused;
     bool down = event->type == SDL_MOUSEBUTTONDOWN;
     if (!im->forward_all_clicks) {
-        if (control && !paused) {
+        if (control) {
             enum sc_action action = down ? SC_ACTION_DOWN : SC_ACTION_UP;
 
             if (im->kp && event->button == SDL_BUTTON_X1) {
@@ -752,7 +747,7 @@ sc_input_manager_process_mouse_button(struct sc_input_manager *im,
         // otherwise, send the click event to the device
     }
 
-    if (!im->mp || paused) {
+    if (!im->mp) {
         return;
     }
 
@@ -890,10 +885,9 @@ void
 sc_input_manager_handle_event(struct sc_input_manager *im,
                               const SDL_Event *event) {
     bool control = im->controller;
-    bool paused = im->screen->paused;
     switch (event->type) {
         case SDL_TEXTINPUT:
-            if (!im->kp || paused) {
+            if (!im->kp) {
                 break;
             }
             sc_input_manager_process_text_input(im, &event->text);
@@ -905,13 +899,13 @@ sc_input_manager_handle_event(struct sc_input_manager *im,
             sc_input_manager_process_key(im, &event->key);
             break;
         case SDL_MOUSEMOTION:
-            if (!im->mp || paused) {
+            if (!im->mp) {
                 break;
             }
             sc_input_manager_process_mouse_motion(im, &event->motion);
             break;
         case SDL_MOUSEWHEEL:
-            if (!im->mp || paused) {
+            if (!im->mp) {
                 break;
             }
             sc_input_manager_process_mouse_wheel(im, &event->wheel);
@@ -925,7 +919,7 @@ sc_input_manager_handle_event(struct sc_input_manager *im,
         case SDL_FINGERMOTION:
         case SDL_FINGERDOWN:
         case SDL_FINGERUP:
-            if (!im->mp || paused) {
+            if (!im->mp) {
                 break;
             }
             sc_input_manager_process_touch(im, &event->tfinger);

app/src/screen.c

@@ -362,8 +362,6 @@ sc_screen_init(struct sc_screen *screen,
     screen->maximized = false;
     screen->minimized = false;
     screen->mouse_capture_key_pressed = 0;
-    screen->paused = false;
-    screen->resume_frame = NULL;
 
     screen->req.x = params->window_x;
     screen->req.y = params->window_y;
@@ -616,10 +614,13 @@ prepare_for_frame(struct sc_screen *screen, struct sc_size new_frame_size) {
 }
 
 static bool
-sc_screen_apply_frame(struct sc_screen *screen) {
+sc_screen_update_frame(struct sc_screen *screen) {
+    av_frame_unref(screen->frame);
+    sc_frame_buffer_consume(&screen->fb, screen->frame);
+    AVFrame *frame = screen->frame;
+
     sc_fps_counter_add_rendered_frame(&screen->fps_counter);
 
-    AVFrame *frame = screen->frame;
     struct sc_size new_frame_size = {frame->width, frame->height};
     enum sc_display_result res = prepare_for_frame(screen, new_frame_size);
     if (res == SC_DISPLAY_RESULT_ERROR) {
@@ -654,54 +655,6 @@ sc_screen_apply_frame(struct sc_screen *screen) {
     return true;
 }
 
-static bool
-sc_screen_update_frame(struct sc_screen *screen) {
-    if (screen->paused) {
-        if (!screen->resume_frame) {
-            screen->resume_frame = av_frame_alloc();
-            if (!screen->resume_frame) {
-                LOG_OOM();
-                return false;
-            }
-        } else {
-            av_frame_unref(screen->resume_frame);
-        }
-        sc_frame_buffer_consume(&screen->fb, screen->resume_frame);
-        return true;
-    }
-
-    av_frame_unref(screen->frame);
-    sc_frame_buffer_consume(&screen->fb, screen->frame);
-    return sc_screen_apply_frame(screen);
-}
-
-void
-sc_screen_set_paused(struct sc_screen *screen, bool paused) {
-    if (!paused && !screen->paused) {
-        // nothing to do
-        return;
-    }
-
-    if (screen->paused && screen->resume_frame) {
-        // If display screen was paused, refresh the frame immediately, even if
-        // the new state is also paused.
-        av_frame_free(&screen->frame);
-        screen->frame = screen->resume_frame;
-        screen->resume_frame = NULL;
-        sc_screen_apply_frame(screen);
-    }
-
-    if (!paused) {
-        LOGI("Display screen unpaused");
-    } else if (!screen->paused) {
-        LOGI("Display screen paused");
-    } else {
-        LOGI("Display screen re-paused");
-    }
-
-    screen->paused = paused;
-}
-
 void
 sc_screen_switch_fullscreen(struct sc_screen *screen) {
     uint32_t new_mode = screen->fullscreen ? 0 : SDL_WINDOW_FULLSCREEN_DESKTOP;

app/src/screen.h

@@ -64,9 +64,6 @@ struct sc_screen {
     SDL_Keycode mouse_capture_key_pressed;
 
     AVFrame *frame;
-
-    bool paused;
-    AVFrame *resume_frame;
 };
 
 struct sc_screen_params {
@@ -138,10 +135,6 @@ void
 sc_screen_set_orientation(struct sc_screen *screen,
                           enum sc_orientation orientation);
 
-// set the display pause state
-void
-sc_screen_set_paused(struct sc_screen *screen, bool paused);
-
 // react to SDL events
 // If this function returns false, scrcpy must exit with an error.
 bool

doc/audio.md

@@ -35,7 +35,7 @@ scrcpy --no-video
 # interrupt with Ctrl+C
 ```
 
-Without video, the audio latency is typically not criticial, so it might be
+Without video, the audio latency is typically not critical, so it might be
 interesting to add [buffering](#buffering) to minimize glitches:
 
 ```

doc/build.md

@@ -94,7 +94,7 @@ This is the preferred method (and the way the release is built).
 From _Debian_, install _mingw_:
 
 ```bash
-sudo apt install mingw-w64 mingw-w64-tools
+sudo apt install mingw-w64 mingw-w64-tools libz-mingw-w64-dev
 ```
 
 You also need the JDK to build the server:

doc/shortcuts.md

@@ -28,8 +28,6 @@ _<kbd>[Super]</kbd> is typically the <kbd>Windows</kbd> or <kbd>Cmd</kbd> key._
  | Rotate display right                        | <kbd>MOD</kbd>+<kbd>→</kbd> _(right)_
  | Flip display horizontally                   | <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>←</kbd> _(left)_ \| <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>→</kbd> _(right)_
  | Flip display vertically                     | <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>↑</kbd> _(up)_ \| <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>↓</kbd> _(down)_
- | Pause or re-pause display                   | <kbd>MOD</kbd>+<kbd>z</kbd>
- | Unpause display                             | <kbd>MOD</kbd>+<kbd>Shift</kbd>+<kbd>z</kbd>
  | Resize window to 1:1 (pixel-perfect)        | <kbd>MOD</kbd>+<kbd>g</kbd>
  | Resize window to remove black borders       | <kbd>MOD</kbd>+<kbd>w</kbd> \| _Double-left-click¹_
  | Click on `HOME`                             | <kbd>MOD</kbd>+<kbd>h</kbd> \| _Middle-click_